OperatorHub API
OperatorHub API のリファレンスガイド
概要
第1章 OperatorHub API
1.1. CatalogSource [operators.coreos.com/v1alpha1]
- 説明
- CatalogSource は、CSV、CRD、および Operator パッケージのリポジトリーです。
- 型
-
object
1.2. ClusterServiceVersion [operators.coreos.com/v1alpha1]
- 説明
-
ClusterServiceVersion は、タイプ
ClusterServiceVersionSpec
のカスタムリソースです。 - 型
-
object
1.3. InstallPlan [operators.coreos.com/v1alpha1]
- 説明
- InstallPlan は、一連の Operator のインストールを定義します。
- 型
-
object
1.4. OLMConfig [operators.coreos.com/v1]
- 説明
- OLMConfig は、OLM の設定を担うリソースです。
- 型
-
object
1.5. Operator [operators.coreos.com/v1]
- 説明
- Operator はクラスター Operator を表します。
- 型
-
object
1.6. OperatorCondition [operators.coreos.com/v2]
- 説明
-
OperatorCondition は、
OperatorCondition
タイプのカスタムリソースであり、Operator の状態に関する情報を OLM に伝達するために使用されます。 - 型
-
object
1.7. OperatorGroup [operators.coreos.com/v1]
- 説明
- OperatorGroup は、OLM マネージドオペレーターのマルチテナンシーの単位です。名前空間への Operator のインストールを、指定されたターゲット名前空間のセットに制限します。
- 型
-
object
1.8. PackageManifest [packages.operators.coreos.com/v1]
- 説明
- PackageManifest は、パッケージに関する情報を保持します。これは、単一のパッケージの下にある 1 つ (または複数) のチャネルへの参照です。
- 型
-
object
1.9. Subscription [operators.coreos.com/v1alpha1]
- 説明
- サブスクリプションは、カタログへの変更を追跡することにより、Operator を最新の状態に保ちます。
- 型
-
object
第2章 CatalogSource [operators.coreos.com/v1alpha1]
- 説明
- CatalogSource は、CSV、CRD、および Operator パッケージのリポジトリーです。
- 型
-
object
- 必須
-
metadata
-
spec
-
2.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| |
|
|
2.1.1. .spec
- 説明
- 型
-
object
- 必須
-
sourceType
-
プロパティー | 型 | 説明 |
---|---|---|
|
| アドレスは、OLM が既存のレジストリーに接続するために使用できるホストです。形式: <registry-host or ip>:<port> SourceType = SourceTypeGrpc の場合にのみ使用されます。イメージフィールドが設定されている場合は無視されます。 |
|
| ConfigMap は、configmap-server レジストリーをバックアップするために使用される ConfigMap の名前です。SourceType=SourceTypeConfigmap または SourceTypeInternal の場合にのみ使用されます。 |
|
| |
|
| メタデータ |
|
| GrpcPodConfig は、CatalogSource Pod の Pod 仕様のさまざまなオーバーライドを公開します。SourceType = SourceTypeGrpc かつ Image が設定されている場合にのみ使用されます。 |
|
| |
|
| イメージは、レジストリーサーバーをインスタンス化するための Operator レジストリーコンテナーイメージです。SourceType=SourceTypeGrpc の場合にのみ使用されます。存在する場合、アドレスフィールドは無視されます。 |
|
| 優先度フィールドは、カタログソースに重みを割り当てて優先順位を付け、依存関係リゾルバーで使用できるようにします。使用法: 重みが大きいほど、依存関係の解決時に、重みが小さいカタログソースよりもこのカタログソースが優先されることを示します。優先度の値の範囲は、int32 の範囲で正から負になります。優先度が割り当てられていないカタログソースのデフォルト値は 0 です。同じ優先度の値を持つカタログソースは、その名前に基づいて辞書式にランク付けされます。 |
|
| |
|
| シークレットは、カタログのコンテンツにアクセスするために使用できるシークレットのセットを表します。カタログエントリーごとにそれぞれを試す必要があるため、このリストは小さくしておくことを推奨します。 |
|
| SourceType はソースのタイプです |
|
| UpdateStrategy は、更新されたカタログソースイメージを検出する方法を定義します。ポーリング期間と埋め込まれた戦略タイプを定義する間隔で設定されます。 |
2.1.2. .spec.grpcPodConfig
- 説明
- GrpcPodConfig は、CatalogSource Pod の Pod 仕様のさまざまなオーバーライドを公開します。SourceType = SourceTypeGrpc かつ Image が設定されている場合にのみ使用されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。 |
|
| 指定した場合、Pod の優先度を示します。指定しない場合、Pod の優先度はデフォルトになり、デフォルトがない場合はゼロになります。 |
|
|
SecurityContextConfig は |
|
| toleration は、カタログソースの Pod の toleration です。 |
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
2.1.3. .spec.grpcPodConfig.tolerations
- 説明
- toleration は、カタログソースの Pod の toleration です。
- 型
-
array
2.1.4. .spec.grpcPodConfig.tolerations[]
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。 |
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
2.1.5. .spec.icon
- 説明
- 型
-
object
- 必須
-
base64data
-
mediatype
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
2.1.6. .spec.updateStrategy
- 説明
- UpdateStrategy は、更新されたカタログソースイメージを検出する方法を定義します。ポーリング期間と埋め込まれた戦略タイプを定義する間隔で設定されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
2.1.7. .spec.updateStrategy.registryPoll
- 説明
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 間隔は、最新のカタログソースバージョンのチェック間の時間間隔を決定するために使用されます。カタログ Operator は、カタログソースの新しいバージョンが利用可能かどうかを確認するためにポーリングします。利用可能な場合、最新のイメージがプルされ、gRPC トラフィックは最新のカタログソースに転送されます。 |
2.1.8. .status
- 説明
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| CatalogSource の状態を表します。メッセージと理由は元のステータス情報を表し、将来的に条件に基づいて移行される可能性があることに注意してください。導入された新機能はすべて条件を使用します。 |
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded"//+ patchMergeKey = type//+ patchStrategy = merge//+ listType = map//+ listMapKey = type Conditions metav1.Condition |
|
| |
|
| |
|
| イメージが最新であることを確認するために CatalogSource イメージレジストリーが最後にポーリングされたとき |
|
| CatalogSource がこの状態にある理由の詳細を示す人間が読めるメッセージ。 |
|
| 理由は、CatalogSource が現在の状態に移行した理由です。 |
|
|
2.1.9. .status.conditions
- 説明
- CatalogSource の状態を表します。メッセージと理由は元のステータス情報を表し、将来的に条件に基づいて移行される可能性があることに注意してください。導入された新機能はすべて条件を使用します。
- 型
-
array
2.1.10. .status.conditions[]
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields } - 型
-
object
- 必須
-
lastTransitionTime
-
message
-
reason
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
2.1.11. .status.configMapReference
- Description
- 型
-
object
- 必須
-
name
-
namespace
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| UID は、UUID を含む一意の ID 値を保持するタイプです。UUID のみを使用するわけではないため、これは文字列のエイリアスです。タイプであることは意図を捉え、UID と名前が混同されないようにするのに役立ちます。 |
2.1.12. .status.connectionState
- Description
- 型
-
object
- 必須
-
lastObservedState
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
2.1.13. .status.registryService
- Description
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v1alpha1/catalogsources
-
GET
: kind が CatalogSource のオブジェクトをリスト表示します。
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources
-
DELETE
: CatalogSource のコレクションを削除します。 -
GET
: kind が CatalogSource のオブジェクトをリスト表示します。 -
POST
:CatalogSource を作成します
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}
-
DELETE
: CatalogSource を削除します。 -
GET
: 指定された CatalogSource を読み取ります -
PATCH
: 指定された CatalogSource を部分的に更新します -
PUT
: 指定された CatalogSource を置き換えます
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}/status
-
GET
: 指定された CatalogSource のステータスを読み取ります -
PATCH
: 指定された CatalogSource のステータスを部分的に更新します -
PUT
: 指定された CatalogSource のステータスを置き換えます
-
2.2.1. /apis/operators.coreos.com/v1alpha1/catalogsources
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が CatalogSource のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
2.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CatalogSource のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類 CatalogSource のオブジェクトをリスト表示します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CatalogSource を作成します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
2.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CatalogSource の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CatalogSource を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された CatalogSource を読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CatalogSource を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CatalogSource を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
2.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/catalogsources/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| CatalogSource の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された CatalogSource のステータスを読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CatalogSource のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CatalogSource のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第3章 ClusterServiceVersion [operators.coreos.com/v1alpha1]
- 説明
-
ClusterServiceVersion は、タイプ
ClusterServiceVersionSpec
のカスタムリソースです。 - 型
-
object
- 必須
-
metadata
-
spec
-
3.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| ClusterServiceVersionSpec 宣言は、特定のバージョンのアプリを管理できる Operator をインストールする方法を OLM に指示します。 |
|
| ClusterServiceVersionStatus は、CSV のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。 |
3.1.1. .spec
- 説明
- ClusterServiceVersionSpec 宣言は、特定のバージョンのアプリを管理できる Operator をインストールする方法を OLM に指示します。
- 型
-
object
- 必須
-
displayName
-
install
-
プロパティー | 型 | 説明 |
---|---|---|
|
| アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。 |
|
| APIServiceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要なすべての拡張機能 apis を宣言します。 |
|
| クリーンアップは、CSV が削除されたときのクリーンアップ動作を指定します |
|
| CustomResourceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要な CRD をすべて宣言します。CRD が Owned リストにある場合、暗黙的に必要になります。 |
|
| |
|
| |
|
| |
|
| |
|
| NamedInstallStrategy は、インストール戦略が指定されている ClusterServiceVersion リソースのブロックを表します。 |
|
| InstallModes は、サポートされているインストールタイプを指定します |
|
| InstallMode は、InstallModeType を CSV がサポートするかどうかを表すフラグに関連付けます。 |
|
| |
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。 |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| GroupVersionKind では、kind をあいまいに識別します。自動的な強制変換を回避するために、GroupVersion を匿名で含めていません。カスタムマーシャリングを回避するために GroupVersion を使用しません。 |
|
| |
|
| Operator がそれらの機能を実行するために必要となる可能性のある関連イメージまたは他のコンテナーをリスト表示します。このリストには、オペランドイメージも含める必要があります。すべてのイメージ参照は、タグではなくダイジェスト (SHA) で指定する必要があります。このフィールドはカタログの作成時にのみ使用され、クラスターの実行時には何のロールも果たしません。 |
|
| |
|
|
これが置き換える CSV の名前。古い CSV の |
|
| 関連リソースのラベルセレクター。 |
|
|
アップグレードグラフでスキップする必要がある 1 つ以上の CSV の名前。スキップする必要がある CSV の |
|
| |
|
| |
|
| WebhookDescription は、必要な Webhook に関する詳細を OLM に提供します |
3.1.2. .spec.apiservicedefinitions
- 説明
- APIServiceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要なすべての拡張機能 apis を宣言します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します |
|
| |
|
| APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します |
3.1.3. .spec.apiservicedefinitions.owned
- 説明
- 型
-
array
3.1.4. .spec.apiservicedefinitions.owned[]
- 説明
- APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します
- 型
-
object
- 必須
-
group
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです |
|
| |
|
| SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。 |
|
| |
|
| StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します |
|
|
3.1.5. .spec.apiservicedefinitions.owned[].actionDescriptors
- 説明
- 型
-
array
3.1.6. .spec.apiservicedefinitions.owned[].actionDescriptors[]
- 説明
- ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.7. .spec.apiservicedefinitions.owned[].resources
- 説明
- 型
-
array
3.1.8. .spec.apiservicedefinitions.owned[].resources[]
- Description
- APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです
- タイプ
-
object
- 必須
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
3.1.9. .spec.apiservicedefinitions.owned[].specDescriptors
- 説明
- 型
-
array
3.1.10. .spec.apiservicedefinitions.owned[].specDescriptors[]
- 説明
- SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.11. .spec.apiservicedefinitions.owned[].statusDescriptors
- 説明
- 型
-
array
3.1.12. .spec.apiservicedefinitions.owned[].statusDescriptors[]
- 説明
- StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.13. .spec.apiservicedefinitions.required
- 説明
- 型
-
array
3.1.14. .spec.apiservicedefinitions.required[]
- 説明
- APIServiceDescription は、集約を介して提供される API に関する詳細を OLM に提供します
- 型
-
object
- 必須
-
group
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです |
|
| |
|
| SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。 |
|
| |
|
| StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します |
|
|
3.1.15. .spec.apiservicedefinitions.required[].actionDescriptors
- 説明
- 型
-
array
3.1.16. .spec.apiservicedefinitions.required[].actionDescriptors[]
- 説明
- ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.17. .spec.apiservicedefinitions.required[].resources
- 説明
- 型
-
array
3.1.18. .spec.apiservicedefinitions.required[].resources[]
- Description
- APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです
- タイプ
-
object
- 必須
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
3.1.19. .spec.apiservicedefinitions.required[].specDescriptors
- 説明
- 型
-
array
3.1.20. .spec.apiservicedefinitions.required[].specDescriptors[]
- 説明
- SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.21. .spec.apiservicedefinitions.required[].statusDescriptors
- 説明
- 型
-
array
3.1.22. .spec.apiservicedefinitions.required[].statusDescriptors[]
- 説明
- StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.23. .spec.cleanup
- 説明
- クリーンアップは、CSV が削除されたときのクリーンアップ動作を指定します
- 型
-
object
- 必須
-
enabled
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
3.1.24. .spec.customresourcedefinitions
- 説明
- CustomResourceDefinitions は、ClusterServiceVersion によって実行される Operator によって管理されるか、または必要な CRD をすべて宣言します。CRD が Owned リストにある場合、暗黙的に必要になります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| CRDDescription は、CRD に関する詳細を OLM に提供します |
|
| |
|
| CRDDescription は、CRD に関する詳細を OLM に提供します |
3.1.25. .spec.customresourcedefinitions.owned
- 説明
- 型
-
array
3.1.26. .spec.customresourcedefinitions.owned[]
- 説明
- CRDDescription は、CRD に関する詳細を OLM に提供します
- 型
-
object
- 必須
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです |
|
| |
|
| SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。 |
|
| |
|
| StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します |
|
|
3.1.27. .spec.customresourcedefinitions.owned[].actionDescriptors
- 説明
- 型
-
array
3.1.28. .spec.customresourcedefinitions.owned[].actionDescriptors[]
- 説明
- ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.29. .spec.customresourcedefinitions.owned[].resources
- 説明
- 型
-
array
3.1.30. .spec.customresourcedefinitions.owned[].resources[]
- Description
- APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです
- タイプ
-
object
- 必須
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
3.1.31. .spec.customresourcedefinitions.owned[].specDescriptors
- 説明
- 型
-
array
3.1.32. .spec.customresourcedefinitions.owned[].specDescriptors[]
- 説明
- SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.33. .spec.customresourcedefinitions.owned[].statusDescriptors
- 説明
- 型
-
array
3.1.34. .spec.customresourcedefinitions.owned[].statusDescriptors[]
- 説明
- StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.35. .spec.customresourcedefinitions.required
- 説明
- 型
-
array
3.1.36. .spec.customresourcedefinitions.required[]
- 説明
- CRDDescription は、CRD に関する詳細を OLM に提供します
- 型
-
object
- 必須
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです |
|
| |
|
| SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。 |
|
| |
|
| StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します |
|
|
3.1.37. .spec.customresourcedefinitions.required[].actionDescriptors
- 説明
- 型
-
array
3.1.38. .spec.customresourcedefinitions.required[].actionDescriptors[]
- 説明
- ActionDescriptor は、カスタムリソースインスタンスで実行できる宣言型アクションを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.39. .spec.customresourcedefinitions.required[].resources
- 説明
- 型
-
array
3.1.40. .spec.customresourcedefinitions.required[].resources[]
- Description
- APIResourceReference は、カスタムリソースで使用される Kubernetes リソースタイプです
- タイプ
-
object
- 必須
-
kind
-
name
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
3.1.41. .spec.customresourcedefinitions.required[].specDescriptors
- 説明
- 型
-
array
3.1.42. .spec.customresourcedefinitions.required[].specDescriptors[]
- 説明
- SpecDescriptor は、OLM が使用できるように、CRD のスペックブロック内のフィールドを記述します。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.43. .spec.customresourcedefinitions.required[].statusDescriptors
- 説明
- 型
-
array
3.1.44. .spec.customresourcedefinitions.required[].statusDescriptors[]
- 説明
- StatusDescriptor は、OLM がフィールドを使用できるように、CRD のステータスブロック内のフィールドを記述します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| RawMessage は、生のエンコードされた JSON 値です。Marshaler と Unmarshaler を実装し、JSON デコードを遅らせたり JSON エンコーディングを事前計算したりするために使用できます。 |
|
|
3.1.45. .spec.icon
- 説明
- 型
-
array
3.1.46. .spec.icon[]
- 説明
- 型
-
object
- 必須
-
base64data
-
mediatype
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
3.1.47. .spec.install
- 説明
- NamedInstallStrategy は、インストール戦略が指定されている ClusterServiceVersion リソースのブロックを表します。
- 型
-
object
- 必須
-
strategy
-
プロパティー | 型 | 説明 |
---|---|---|
|
| StrategyDetailsDeployment は、Deployment InstallStrategy の解析された詳細を表します。 |
|
|
3.1.48. .spec.install.spec
- 説明
- StrategyDetailsDeployment は、Deployment InstallStrategy の解析された詳細を表します。
- 型
-
object
- 必須
-
デプロイメント
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します |
|
| |
|
| StrategyDeploymentSpec には、ALM が作成する必要のあるデプロイメントの名前、仕様、およびラベルが含まれています |
|
| |
|
| StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します |
3.1.49. .spec.install.spec.clusterPermissions
- 説明
- 型
-
array
3.1.50. .spec.install.spec.clusterPermissions[]
- 説明
- StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します
- 型
-
object
- 必須
-
rules
-
serviceAccountName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。 |
|
|
3.1.51. .spec.install.spec.clusterPermissions[].rules
- 説明
- 型
-
array
3.1.52. .spec.install.spec.clusterPermissions[].rules[]
- 説明
- PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
- 型
-
object
- 必須
-
verbs
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroups は、リソースを含む APIGroup の名前です。複数の API グループが指定されている場合、任意の API グループ内の列挙されたリソースの 1 つに対してリクエストされたアクションはすべて許可されます。"" はコア API グループを表し、"*" はすべての API グループを表します。 |
|
| NonResourceURLs は、ユーザーがアクセスできる必要のある部分的な URL のセットです。*は許可されますが、パスの完全な最終ステップとしてのみです。非リソース URL は名前空間化されていないため、このフィールドは ClusterRoleBinding から参照される ClusterRoles にのみ適用されます。ルールは、API リソース ("pods" や "secrets" など) または非リソース URL パス ("/api" など) のいずれかに適用できますが、両方に適用することはできません。 |
|
| resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。 |
|
| リソースは、このルールが適用されるリソースのリストです。'*' はすべてのリソースを表します。 |
|
| Verbs は、このルールに含まれるすべての ResourceKind に適用される Verbs のリストです。'*' はすべての動詞を表します。 |
3.1.53. .spec.install.spec.deployments
- 説明
- 型
-
array
3.1.54. .spec.install.spec.deployments[]
- 説明
- StrategyDeploymentSpec には、ALM が作成する必要のあるデプロイメントの名前、仕様、およびラベルが含まれています
- 型
-
object
- 必須
-
name
-
spec
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セットは label:value のマップです。ラベルを実装します。 |
|
| |
|
| DeploymentSpec は、デプロイメントの望ましい動作の仕様です。 |
3.1.55. .spec.install.spec.deployments[].spec
- 説明
- DeploymentSpec は、デプロイメントの望ましい動作の仕様です。
- 型
-
object
- 必須
-
selector
-
template
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 新しく作成された Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます) |
|
| デプロイメントが一時停止されていることを示します。 |
|
| デプロイメントが失敗したと見なされる前に、デプロイメントが進行するまでの最大時間 (秒単位)。デプロイメントコントローラーは失敗したデプロイメントの処理を続行し、ProgressDeadlineExceeded 理由のある条件がデプロイメントステータスに表示されます。デプロイメントが一時停止している間は、進行状況は推定されないことに注意してください。デフォルトは 600 秒です。 |
|
| 必要な Pod の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。 |
|
| ロールバックを可能にするために保持する古い ReplicaSet の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 10 です。 |
|
| Pod のラベルセレクター。これによって Pod が選択される既存の ReplicaSet は、このデプロイメントの影響を受けるものになります。Pod テンプレートのラベルと一致する必要があります。 |
|
| 既存の Pod を新しい Pod に置き換えるために使用するデプロイメント戦略。 |
|
| テンプレートには、作成される Pod が記述されています。 |
3.1.56. .spec.install.spec.deployments[].spec.selector
- 説明
- Pod のラベルセレクター。これによって Pod が選択される既存の ReplicaSet は、このデプロイメントの影響を受けるものになります。Pod テンプレートのラベルと一致する必要があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.57. .spec.install.spec.deployments[].spec.selector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.58. .spec.install.spec.deployments[].spec.selector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.59. .spec.install.spec.deployments[].spec.strategy
- 説明
- 既存の Pod を新しい Pod に置き換えるために使用するデプロイメント戦略。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ローリング更新の設定パラメーター。DeploymentStrategyType=RollingUpdate の場合にのみ存在します。--- TODO: これを更新して、oneOf の規則に従うようにします。 |
|
| デプロイメントのタイプ。"Recreate" または "RollingUpdate" にすることができます。デフォルトは RollingUpdate です。 |
3.1.60. .spec.install.spec.deployments[].spec.strategy.rollingUpdate
- 説明
- ローリング更新の設定パラメーター。DeploymentStrategyType=RollingUpdate の場合にのみ存在します。--- TODO: これを更新して、oneOf の規則に従うようにします。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 希望する Pod 数を超えてスケジュールできる Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。MaxUnavailable が 0 の場合、これを 0 にすることはできません。絶対数は、端数を切り上げてパーセンテージから計算されます。デフォルトは 25% です。例: これが 30% に設定されている場合、ローリング更新の開始時に新しい ReplicaSet をすぐにスケールアップして、新旧の Pod の総数が目的の Pod の 130% を超えないようにすることができます。古い Pod が強制終了されると、新しい ReplicaSet をさらにスケールアップして、更新中にいつでも実行されている Pod の総数が目的の Pod の最大 130% になるようにすることができます。 |
|
| 更新中に使用できなくなる可能性のある Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。絶対数は、端数を切り捨ててパーセンテージから計算されます。MaxSurge が 0 の場合、これを 0 にすることはできません。デフォルトは 25% です。例: これが 30% に設定されている場合、ローリング更新が開始されるとすぐに、古い ReplicaSet を目的の Pod の 70% に縮小できます。新しい Pod の準備ができたら、古い ReplicaSet をさらにスケールダウンしてから、新しい ReplicaSet をスケールアップして、更新中に常に使用可能な Pod の総数が目的の Pod の少なくとも 70% になるようにします。 |
3.1.61. .spec.install.spec.deployments[].spec.template
- 説明
- テンプレートには、作成される Pod が記述されています。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
| `` | 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 |
|
| Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
3.1.62. .spec.install.spec.deployments[].spec.template.spec
- 説明
- Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- 型
-
object
- 必須
-
containers
-
プロパティー | 型 | 説明 |
---|---|---|
|
| システムがアクティブに失敗のマークを付けて関連するコンテナーを強制終了する前に、StartTime を基準にして Pod がノード上でアクティブになる可能性がある秒単位のオプションの期間。その値は正の整数でなければなりません。 |
|
| 指定されている場合、Pod のスケジューリング制約 |
|
| AutomountServiceAccountToken は、サービスアカウントトークンを自動的にマウントする必要があるかどうかを示します。 |
|
| Pod に属するコンテナーのリスト。現在、コンテナーを追加または削除することはできません。Pod には少なくとも 1 つのコンテナーが必要です。これを更新することはできません。 |
|
| Pod 内で実行する単一のアプリケーションコンテナー。 |
|
| Pod の DNS パラメーターを指定します。ここで指定されたパラメーターは、DNSPolicy に基づいて生成された DNS 設定にマージされます。 |
|
| Pod の DNS ポリシーを設定します。デフォルトは "ClusterFirst" です。有効な値は、'ClusterFirstWithHostNet'、'ClusterFirst'、'Default'、または 'None' です。DNSConfig で指定された DNS パラメーターは、DNSPolicy で選択されたポリシーとマージされます。hostNetwork とともに DNS オプションを設定するには、DNS ポリシーを 'ClusterFirstWithHostNet' に明示的に指定する必要があります。 |
|
| EnableServiceLinks は、Docker リンクの構文と一致して、サービスに関する情報を Pod の環境変数に挿入する必要があるかどうかを示します。オプション: デフォルトは true です。 |
|
| この Pod で実行されるエフェメラルコンテナーのリスト。エフェメラルコンテナーを既存の Pod で実行して、デバッグなどのユーザーが開始するアクションを実行できます。このリストは、Pod の作成時に指定することはできません。また、Pod の仕様を更新して変更することもできません。エフェメラルコンテナーを既存の Pod に追加するには、Pod のエフェメラルコンテナーサブリソースを使用します。 |
|
| EphemeralContainer は、デバッグなど、ユーザーが開始したアクティビティーに対して、既存の Pod に追加できる一時コンテナーです。エフェメラルコンテナーにはリソースやスケジュールの保証がなく、コンテナーの終了時、または Pod の削除または再起動時に再起動されません。エフェメラルコンテナーが原因で Pod がリソース割り当てを超過した場合、kubelet は Pod をエビクトする可能性があります。エフェメラルコンテナーを追加するには、既存の Pod の ephemeralcontainers サブリソースを使用します。エフェメラルコンテナーは削除または再起動できません。 |
|
| HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。これは、hostNetwork 以外の Pod にのみ有効です。 |
|
| HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。 |
|
| ホストの ipc 名前空間を使用します。オプション: デフォルトは false です。 |
|
| この Pod に要求されたホストネットワーク。ホストのネットワーク名前空間を使用します。このオプションを設定する場合は、使用するポートを指定する必要があります。デフォルトは false です。 |
|
| ホストの pid 名前空間を使用します。オプション: デフォルトは false です。 |
|
| ホストのユーザー namespace を使用します。任意: デフォルトは true です。true に設定するか存在しない場合、Pod はホストユーザーの namespace で実行されます。これは、CAP_SYS_MODULE を使用したカーネルモジュールのロードなど、ホストユーザー namespace でのみ利用できる機能が Pod に必要な場合に役立ちます。false に設定すると、Pod 用に新しい userns が作成されます。false に設定すると、コンテナーブレークアウトの脆弱性を軽減するのに役立ち、ユーザーがホスト上で実際に root 権限を持たずにコンテナーを root として実行できるようになります。このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にするサーバーでのみ認識されます。 |
|
| Pod のホスト名を指定します指定しない場合、Pod のホスト名はシステム定義の値に設定されます。 |
|
| ImagePullSecrets は、この PodSpec で使用されるイメージをプルするために使用する、同じ名前空間内のシークレットへの参照のオプションのリストです。指定されている場合、これらのシークレットは、使用するために個々のプラー実装に渡されます。詳細: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
|
| LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。 |
|
| Pod に属する初期化コンテナーのリスト。コンテナーが開始される前に、初期化コンテナーが順番に実行されます。init コンテナーに障害が発生した場合、Pod は障害が発生したと見なされ、restartPolicy に従って処理されます。init コンテナーまたは通常のコンテナーの名前は、すべてのコンテナー間で一意である必要があります。Init コンテナーには、ライフサイクルアクション、準備プローブ、ライブネスプローブ、またはスタートアッププローブがない場合があります。init コンテナーの resourceRequirements は、各リソースタイプの最大の要求/制限を見つけ、その値の最大値または通常のコンテナーの合計を使用することにより、スケジューリング中に考慮されます。同様の方法で、init コンテナーに制限が適用されます。現在、初期化コンテナーを追加または削除することはできません。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
|
| Pod 内で実行する単一のアプリケーションコンテナー。 |
|
| NodeName は、この Pod を特定のノードにスケジュールするためのリクエストです。空でない場合、スケジューラーは、リソース要件に適合していると想定して、この Pod をそのノードにスケジュールするだけです。 |
|
| NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。詳細: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
|
| Pod 内のコンテナーの OS を指定します。これが設定されている場合、一部の Pod およびコンテナーフィールドは制限されます。OS フィールドが Windows に設定されている場合は、次のフィールドの設定を解除する必要があります。- spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup |
|
| オーバーヘッドは、特定の RuntimeClass の Pod の実行に関連するリソースオーバーヘッドを表します。このフィールドは、RuntimeClass アドミッションコントローラーによってアドミッション時に自動入力されます。RuntimeClass アドミッションコントローラーが有効になっている場合は、Pod 作成要求でオーバーヘッドを設定しないでください。RuntimeClass アドミッションコントローラーは、オーバーヘッドがすでに設定されている Pod 作成要求を拒否します。RuntimeClass が PodSpec で設定および選択されている場合、オーバーヘッドは対応する RuntimeClass で定義されている値に設定されます。それ以外の場合は、未設定のままでゼロとして扱われます。詳細は、https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md を参照してください。 |
|
| PreemptionPolicy は、優先度の低い Pod をプリエンプトするためのポリシーです。Never、PreemptLowerPriority の 1 つ。設定されていない場合、デフォルトは PreemptLowerPriority です。 |
|
| 優先度の値。さまざまなシステムコンポーネントがこのフィールドを使用して、Pod の優先度を検索します。Priority Admission Controller が有効になっている場合、ユーザーはこのフィールドを設定できません。アドミッションコントローラーは、PriorityClassName からこのフィールドに入力します。値が高いと優先順位が高くなります。 |
|
| 指定されている場合、Pod の優先度を示します。"system-node-critical" と "system-cluster-critical" は、最も高い優先度を示す 2 つの特別なキーワードであり、前者が最も高い優先度です。その他の名前は、その名前で PriorityClass オブジェクトを作成して定義する必要があります。指定しない場合、Pod の優先度はデフォルトになり、デフォルトがない場合はゼロになります。 |
|
| 指定した場合、すべての準備ゲートが Pod の準備状況に対して評価されます。すべてのコンテナーの準備が整い、準備ゲートで指定されたすべての条件のステータスが "True" になると、Pod の準備が整います。詳細: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates |
|
| PodReadinessGate には、Pod 条件への参照が含まれています |
|
| Pod 内のすべてのコンテナーのポリシーを再起動します。Always、OnFailure、Never のいずれか。デフォルトは Always です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
|
| RuntimeClassName は、node.k8s.io グループ内の RuntimeClass オブジェクトを参照します。このオブジェクトは、この Pod を実行するために使用する必要があります。指定されたクラスに一致する RuntimeClass リソースがない場合、Pod は実行されません。設定されていないか空の場合は、"レガシー" の RuntimeClass が使用されます。これは、デフォルトのランタイムハンドラーを使用する空の定義を持つ暗黙のクラスです。詳細は、https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class を参照してください。 |
|
| 指定した場合、Pod は指定したスケジューラーによってディスパッチされます。指定しない場合、Pod はデフォルトのスケジューラーによってディスパッチされます。 |
|
| SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。オプション: デフォルトは空です。各フィールドのデフォルト値は、タイプの説明を参照してください。 |
|
| DeprecatedServiceAccount は、ServiceAccountName の減価償却されたエイリアスです。非推奨: 代わりに serviceAccountName を使用してください。 |
|
| ServiceAccountName は、この Pod の実行に使用する ServiceAccount の名前です。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
|
| true の場合、Pod のホスト名は、リーフ名 (デフォルト) ではなく、Pod の FQDN として設定されます。Linux コンテナーでは、これはカーネルのホスト名フィールド (struct utsname のノード名フィールド) に FQDN を設定することを意味します。Windows コンテナーでは、これはレジストリーキー HKEY_LOCAL_MACHINE \\ SYSTEM \\ CurrentControlSet \\ Services \\ Tcpip\\Parameters のホスト名のレジストリー値を FQDN に設定することを意味します。Pod に FQDN がない場合、これは効果がありません。デフォルトは false です。 |
|
| Pod 内のすべてのコンテナー間で単一のプロセス名前空間を共有します。これが設定されると、コンテナーは同じ Pod 内の他のコンテナーからのプロセスを表示および通知できるようになり、各コンテナーの最初のプロセスには PID1 が割り当てられません。HostPID と ShareProcessNamespace の両方を設定することはできません。オプション: デフォルトは false です。 |
|
| 指定した場合、完全修飾 Pod のホスト名は "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>" になります。指定しない場合、Pod にはドメイン名がまったくありません。 |
|
| Pod が正常に終了する必要がある秒単位のオプションの期間。削除リクエストで減少する可能性があります。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。この値が nil の場合、代わりにデフォルトの猶予期間が使用されます。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。デフォルトは 30 秒です。 |
|
| 指定されている場合、Pod の許容範囲。 |
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
|
| TopologySpreadConstraints は、Pod のグループがトポロジードメイン全体にどのように分散するべきかを説明します。スケジューラーは、制約に従う方法で Pod をスケジュールします。すべての topologySpreadConstraints は AND 演算されます。 |
|
| topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。 |
|
| Pod に属するコンテナーによってマウントできるボリュームのリスト。詳細: https://kubernetes.io/docs/concepts/storage/volumes |
|
| ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。 |
3.1.63. .spec.install.spec.deployments[].spec.template.spec.affinity
- 説明
- 指定されている場合、Pod のスケジューリング制約
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Pod のノードアフィニティースケジューリングルールを説明します。 |
|
| Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。 |
|
| Pod の非アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。 |
3.1.64. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity
- 説明
- Pod のノードアフィニティースケジューリングルールを説明します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
| 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。 |
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。 |
3.1.65. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 説明
- スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
- 型
-
array
3.1.66. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 説明
- 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
- 型
-
object
- 必須
-
preference
-
weight
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 対応する重みに関連付けられたノードセレクター用語。 |
|
| 対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。 |
3.1.67. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
- 説明
- 対応する重みに関連付けられたノードセレクター用語。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
3.1.68. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
3.1.69. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.70. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
3.1.71. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.72. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 説明
- このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。
- 型
-
object
- 必須
-
nodeSelectorTerms
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。ノードセレクター用語のリスト。用語は OR されています。 |
|
| null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。 |
3.1.73. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
- 説明
- 必須。ノードセレクター用語のリスト。用語は OR されています。
- 型
-
array
3.1.74. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
- 説明
- null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
3.1.75. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
3.1.76. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.77. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
3.1.78. .spec.install.spec.deployments[].spec.template.spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.79. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity
- 説明
- Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
| この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。 |
3.1.80. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 説明
- スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
- 型
-
array
3.1.81. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 説明
- 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
- 型
-
object
- 必須
-
podAffinityTerm
-
weight
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
3.1.82. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
3.1.83. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.84. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.85. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.86. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.87. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.88. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.89. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 説明
- このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
- 型
-
array
3.1.90. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 説明
- この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
3.1.91. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.92. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.93. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.94. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.95. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.96. .spec.install.spec.deployments[].spec.template.spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.97. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity
- 説明
- Pod の非アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
| このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
| この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。 |
3.1.98. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 説明
- スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
- 型
-
array
3.1.99. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 説明
- 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
- 型
-
object
- 必須
-
podAffinityTerm
-
weight
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
3.1.100. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
3.1.101. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.102. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.103. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.104. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.105. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.106. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.107. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 説明
- このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
- 型
-
array
3.1.108. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 説明
- この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
3.1.109. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.110. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.111. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.112. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.113. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.114. .spec.install.spec.deployments[].spec.template.spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.115. .spec.install.spec.deployments[].spec.template.spec.containers
- 説明
- Pod に属するコンテナーのリスト。現在、コンテナーを追加または削除することはできません。Pod には少なくとも 1 つのコンテナーが必要です。これを更新することはできません。
- 型
-
array
3.1.116. .spec.install.spec.deployments[].spec.template.spec.containers[]
- 説明
- Pod 内で実行する単一のアプリケーションコンテナー。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| エントリーポイントへの引数。これが指定されていない場合は、コンテナーイメージの 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 |
|
| エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、コンテナーイメージの 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 |
|
| コンテナーに設定する環境変数のリスト。これを更新することはできません。 |
|
| EnvVar は、コンテナーに存在する環境変数を表します。 |
|
| コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。 |
|
| EnvFromSource は、一連の ConfigMap のソースを表します |
|
| コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。 |
|
| イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
| コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これを更新することはできません。 |
|
| コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| DNS_LABEL として指定されたコンテナーの名前。Pod 内の各コンテナーには、一意の名前 (DNS_LABEL) が必要です。これを更新することはできません。 |
|
| コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これを更新することはできません。 |
|
| ContainerPort は、単一のコンテナー内のネットワークポートを表します。 |
|
| コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| このコンテナーに必要なコンピューティングリソース。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
| SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
| StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。 |
|
| コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。 |
|
| オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。 |
|
| 終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。 |
|
| このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。 |
|
| volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。 |
|
| volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。 |
|
| コンテナーのファイルシステムにマウントする Pod ボリューム。これを更新することはできません。 |
|
| VolumeMount は、コンテナー内でのボリュームのマウントを説明します。 |
|
| コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。 |
3.1.117. .spec.install.spec.deployments[].spec.template.spec.containers[].env
- 説明
- コンテナーに設定する環境変数のリスト。これを更新することはできません。
- 型
-
array
3.1.118. .spec.install.spec.deployments[].spec.template.spec.containers[].env[]
- 説明
- EnvVar は、コンテナーに存在する環境変数を表します。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 環境変数の名前。C_IDENTIFIER でなければなりません。 |
|
| 変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。 |
|
| 環境変数の値のソースです。値が空でない場合は使用できません。 |
3.1.119. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom
- 説明
- 環境変数の値のソースです。値が空でない場合は使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ConfigMap のキーを選択します。 |
|
|
Pod のフィールドを選択します。metadata.name、metadata.namespace、 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。 |
|
| Pod の名前空間でシークレットのキーを選択します |
3.1.120. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.configMapKeyRef
- 説明
- ConfigMap のキーを選択します。
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
3.1.121. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.fieldRef
- 説明
-
Pod のフィールドを選択します。metadata.name、metadata.namespace、
metadata.labels['<KEY>']
、metadata.annotations['<KEY>']
、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs がサポートされています。 - 型
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
3.1.122. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
3.1.123. .spec.install.spec.deployments[].spec.template.spec.containers[].env[].valueFrom.secretKeyRef
- 説明
- Pod の namespace でシークレットのキーを選択します
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
3.1.124. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom
- 説明
- コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。
- 型
-
array
3.1.125. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[]
- 説明
- EnvFromSource は、一連の ConfigMap のソースを表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択する ConfigMap |
|
| ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。 |
|
| から選択する秘密 |
3.1.126. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].configMapRef
- 説明
- 選択する ConfigMap
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap を定義する必要があるかどうかを指定します |
3.1.127. .spec.install.spec.deployments[].spec.template.spec.containers[].envFrom[].secretRef
- 説明
- から選択する秘密
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットを定義する必要があるかどうかを指定します |
3.1.128. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle
- 説明
- コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これを更新することはできません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
| PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
3.1.129. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart
- 説明
- PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
3.1.130. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.131. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.132. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.133. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.134. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.postStart.tcpSocket
- 説明
- 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.135. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop
- 説明
- PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
3.1.136. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.137. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.138. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.139. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.140. .spec.install.spec.deployments[].spec.template.spec.containers[].lifecycle.preStop.tcpSocket
- 説明
- 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.141. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe
- 説明
- コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.142. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.143. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.144. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.145. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.146. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.147. .spec.install.spec.deployments[].spec.template.spec.containers[].livenessProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.148. .spec.install.spec.deployments[].spec.template.spec.containers[].ports
- 説明
- コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これを更新することはできません。
- 型
-
array
3.1.149. .spec.install.spec.deployments[].spec.template.spec.containers[].ports[]
- 説明
- ContainerPort は、単一のコンテナー内のネットワークポートを表します。
- 型
-
object
- 必須
-
containerPort
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。 |
|
| 外部ポートをバインドするホスト IP。 |
|
| ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。 |
|
| 指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。 |
|
| ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。 |
3.1.150. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe
- 説明
- コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.151. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.152. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.153. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.154. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.155. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.156. .spec.install.spec.deployments[].spec.template.spec.containers[].readinessProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.157. .spec.install.spec.deployments[].spec.template.spec.containers[].resources
- 説明
- このコンテナーに必要なコンピューティングリソース。これを更新することはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
3.1.158. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext
- 説明
- SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。 |
|
| コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
|
| コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。 |
3.1.159. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.capabilities
- 説明
- コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 追加された機能 |
|
| 削除された機能 |
3.1.160. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seLinuxOptions
- 説明
- コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Level は、コンテナーに適用される SELinux レベルのラベルです。 |
|
| Role は、コンテナーに適用される SELinux ロールラベルです。 |
|
| Type は、コンテナーに適用される SELinux タイプのラベルです。 |
|
| User は、コンテナーに適用される SELinux ユーザーラベルです。 |
3.1.161. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.seccompProfile
- 説明
- このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。 |
|
| type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。 |
3.1.162. .spec.install.spec.deployments[].spec.template.spec.containers[].securityContext.windowsOptions
- 説明
- すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。 |
|
| GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。 |
|
| hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。 |
|
| コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
3.1.163. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe
- 説明
- StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.164. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.165. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.166. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.167. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.168. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.169. .spec.install.spec.deployments[].spec.template.spec.containers[].startupProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.170. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices
- 説明
- volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
- 型
-
array
3.1.171. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeDevices[]
- 説明
- volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
- 型
-
object
- 必須
-
devicePath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| devicePath は、デバイスがマップされるコンテナー内のパスです。 |
|
| name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります |
3.1.172. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts
- 説明
- コンテナーのファイルシステムにマウントする Pod ボリューム。これを更新することはできません。
- 型
-
array
3.1.173. .spec.install.spec.deployments[].spec.template.spec.containers[].volumeMounts[]
- 説明
- VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
- 型
-
object
- 必須
-
mountPath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。 |
|
| mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。 |
|
| ボリュームの名前に一致する必要があります。 |
|
| true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。 |
3.1.174. .spec.install.spec.deployments[].spec.template.spec.dnsConfig
- 説明
- Pod の DNS パラメーターを指定します。ここで指定されたパラメーターは、DNSPolicy に基づいて生成された DNS 設定にマージされます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| DNS ネームサーバーの IP アドレスのリスト。これは、DNSPolicy から生成されたベースネームサーバーに追加されます。重複したネームサーバーは削除されます。 |
|
| DNS リゾルバーオプションのリスト。これは、DNSPolicy から生成された基本オプションとマージされます。重複したエントリーは削除されます。オプションで指定された解決オプションは、ベース DNS ポリシーに表示されるものをオーバーライドします。 |
|
| PodDNSConfigOption は、Pod の DNS リゾルバーオプションを定義します。 |
|
| ホスト名ルックアップ用の DNS 検索ドメインのリスト。これは、DNSPolicy から生成された基本検索パスに追加されます。重複する検索パスは削除されます。 |
3.1.175. .spec.install.spec.deployments[].spec.template.spec.dnsConfig.options
- 説明
- DNS リゾルバーオプションのリスト。これは、DNSPolicy から生成された基本オプションとマージされます。重複したエントリーは削除されます。オプションで指定された解決オプションは、ベース DNS ポリシーに表示されるものをオーバーライドします。
- 型
-
array
3.1.176. .spec.install.spec.deployments[].spec.template.spec.dnsConfig.options[]
- 説明
- PodDNSConfigOption は、Pod の DNS リゾルバーオプションを定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。 |
|
|
3.1.177. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers
- 説明
- この Pod で実行されるエフェメラルコンテナーのリスト。エフェメラルコンテナーを既存の Pod で実行して、デバッグなどのユーザーが開始するアクションを実行できます。このリストは、Pod の作成時に指定することはできません。また、Pod の仕様を更新して変更することもできません。エフェメラルコンテナーを既存の Pod に追加するには、Pod のエフェメラルコンテナーサブリソースを使用します。
- 型
-
array
3.1.178. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[]
- 説明
- EphemeralContainer は、デバッグなど、ユーザーが開始したアクティビティーに対して、既存の Pod に追加できる一時コンテナーです。エフェメラルコンテナーにはリソースやスケジュールの保証がなく、コンテナーの終了時、または Pod の削除または再起動時に再起動されません。エフェメラルコンテナーが原因で Pod がリソース割り当てを超過した場合、kubelet は Pod をエビクトする可能性があります。エフェメラルコンテナーを追加するには、既存の Pod の ephemeralcontainers サブリソースを使用します。エフェメラルコンテナーは削除または再起動できません。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| エントリーポイントへの引数。このプロパティが指定されていない場合は、イメージの 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 |
|
| エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、イメージの 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 |
|
| コンテナーに設定する環境変数のリスト。これを更新することはできません。 |
|
| EnvVar は、コンテナーに存在する環境変数を表します。 |
|
| コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。 |
|
| EnvFromSource は、一連の ConfigMap のソースを表します |
|
| コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images |
|
| イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
| エフェメラルコンテナーのライフサイクルは許可されていません。 |
|
| 一時的なコンテナーにはプローブを使用できません。 |
|
| DNS_LABEL として指定されたエフェメラルコンテナーの名前。この名前は、すべてのコンテナー、init コンテナー、およびエフェメラルコンテナーの中で一意である必要があります。 |
|
| エフェメラルコンテナーのポートは許可されていません。 |
|
| ContainerPort は、単一のコンテナー内のネットワークポートを表します。 |
|
| 一時的なコンテナーにはプローブを使用できません。 |
|
| エフェメラルコンテナーのリソースは許可されていません。エフェメラルコンテナーは、Pod にすでに割り当てられているスペアリソースを使用します。 |
|
| オプション:SecurityContext は、エフェメラルコンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。 |
|
| 一時的なコンテナーにはプローブを使用できません。 |
|
| このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。 |
|
| コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。 |
|
| 設定されている場合、このエフェメラルコンテナーがターゲットとする PodSpec からのコンテナーの名前。エフェメラルコンテナーは、このコンテナーの namespace (IPC、PID など) で実行されます。設定されていない場合、エフェメラルコンテナーは Pod 仕様で設定された namespace を使用します。コンテナーランタイムは、この機能のサポートを実装する必要があります。ランタイムが namespace ターゲットをサポートしていない場合、このフィールドの設定結果は定義されません。 |
|
| オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。 |
|
| 終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。 |
|
| このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。 |
|
| volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。 |
|
| volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。 |
|
| コンテナーのファイルシステムにマウントする Pod ボリューム。エフェメラルコンテナーでは、サブパスをマウントできません。これを更新することはできません。 |
|
| VolumeMount は、コンテナー内でのボリュームのマウントを説明します。 |
|
| コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。 |
3.1.179. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env
- 説明
- コンテナーに設定する環境変数のリスト。これを更新することはできません。
- 型
-
array
3.1.180. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[]
- 説明
- EnvVar は、コンテナーに存在する環境変数を表します。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 環境変数の名前。C_IDENTIFIER でなければなりません。 |
|
| 変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。 |
|
| 環境変数の値のソースです。値が空でない場合は使用できません。 |
3.1.181. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom
- 説明
- 環境変数の値のソースです。値が空でない場合は使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ConfigMap のキーを選択します。 |
|
|
Pod のフィールドを選択します。metadata.name、metadata.namespace、 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。 |
|
| Pod の namespace でシークレットのキーを選択します |
3.1.182. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.configMapKeyRef
- 説明
- ConfigMap のキーを選択します。
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
3.1.183. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.fieldRef
- 説明
-
Pod のフィールドを選択します。metadata.name、metadata.namespace、
metadata.labels['<KEY>']
、metadata.annotations['<KEY>']
、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs がサポートされています。 - 型
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
3.1.184. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
3.1.185. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].env[].valueFrom.secretKeyRef
- 説明
- Pod の namespace でシークレットのキーを選択します
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
3.1.186. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom
- 説明
- コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。
- 型
-
array
3.1.187. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[]
- 説明
- EnvFromSource は、一連の ConfigMap のソースを表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択する ConfigMap |
|
| ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。 |
|
| から選択する秘密 |
3.1.188. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].configMapRef
- 説明
- 選択する ConfigMap
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap を定義する必要があるかどうかを指定します |
3.1.189. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].envFrom[].secretRef
- 説明
- から選択する秘密
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットを定義する必要があるかどうかを指定します |
3.1.190. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle
- 説明
- エフェメラルコンテナーのライフサイクルは許可されていません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
| PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
3.1.191. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart
- 説明
- PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
3.1.192. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.193. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.194. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.195. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.196. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.postStart.tcpSocket
- 説明
- 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.197. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop
- 説明
- PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
3.1.198. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.199. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.200. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.201. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.202. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].lifecycle.preStop.tcpSocket
- 説明
- 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.203. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe
- 説明
- 一時的なコンテナーにはプローブを使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.204. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.205. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.206. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.207. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.208. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.209. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].livenessProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.210. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports
- 説明
- エフェメラルコンテナーのポートは許可されていません。
- 型
-
array
3.1.211. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].ports[]
- 説明
- ContainerPort は、単一のコンテナー内のネットワークポートを表します。
- 型
-
object
- 必須
-
containerPort
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。 |
|
| 外部ポートをバインドするホスト IP。 |
|
| ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。 |
|
| 指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。 |
|
| ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。 |
3.1.212. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe
- 説明
- 一時的なコンテナーにはプローブを使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.213. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.214. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.215. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.216. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.217. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.218. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].readinessProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.219. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].resources
- 説明
- エフェメラルコンテナーのリソースは許可されていません。エフェメラルコンテナーは、Pod にすでに割り当てられているスペアリソースを使用します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
3.1.220. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext
- 説明
- オプション:SecurityContext は、エフェメラルコンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。 |
|
| コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
|
| コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。 |
3.1.221. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.capabilities
- 説明
- コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 追加された機能 |
|
| 削除された機能 |
3.1.222. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seLinuxOptions
- 説明
- コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Level は、コンテナーに適用される SELinux レベルのラベルです。 |
|
| Role は、コンテナーに適用される SELinux ロールラベルです。 |
|
| Type は、コンテナーに適用される SELinux タイプのラベルです。 |
|
| User は、コンテナーに適用される SELinux ユーザーラベルです。 |
3.1.223. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.seccompProfile
- 説明
- このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。 |
|
| type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。 |
3.1.224. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].securityContext.windowsOptions
- 説明
- すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。 |
|
| GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。 |
|
| hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。 |
|
| コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
3.1.225. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe
- 説明
- 一時的なコンテナーにはプローブを使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.226. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.227. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.228. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.229. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.230. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.231. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].startupProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.232. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices
- 説明
- volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
- 型
-
array
3.1.233. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeDevices[]
- 説明
- volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
- 型
-
object
- 必須
-
devicePath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| devicePath は、デバイスがマップされるコンテナー内のパスです。 |
|
| name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります |
3.1.234. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts
- 説明
- コンテナーのファイルシステムにマウントする Pod ボリューム。エフェメラルコンテナーでは、サブパスをマウントできません。これを更新することはできません。
- 型
-
array
3.1.235. .spec.install.spec.deployments[].spec.template.spec.ephemeralContainers[].volumeMounts[]
- 説明
- VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
- 型
-
object
- 必須
-
mountPath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。 |
|
| mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。 |
|
| ボリュームの名前に一致する必要があります。 |
|
| true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。 |
3.1.236. .spec.install.spec.deployments[].spec.template.spec.hostAliases
- 説明
- HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。これは、hostNetwork 以外の Pod にのみ有効です。
- 型
-
array
3.1.237. .spec.install.spec.deployments[].spec.template.spec.hostAliases[]
- 説明
- HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 上記の IP アドレスのホスト名。 |
|
| ホストファイルエントリーの IP アドレス。 |
3.1.238. .spec.install.spec.deployments[].spec.template.spec.imagePullSecrets
- 説明
- ImagePullSecrets は、この PodSpec で使用されるイメージをプルするために使用する、同じ名前空間内のシークレットへの参照のオプションのリストです。指定されている場合、これらのシークレットは、使用するために個々のプラー実装に渡されます。詳細: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
- 型
-
array
3.1.239. .spec.install.spec.deployments[].spec.template.spec.imagePullSecrets[]
- 説明
- LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.240. .spec.install.spec.deployments[].spec.template.spec.initContainers
- 説明
- Pod に属する初期化コンテナーのリスト。コンテナーが開始される前に、初期化コンテナーが順番に実行されます。init コンテナーに障害が発生した場合、Pod は障害が発生したと見なされ、restartPolicy に従って処理されます。init コンテナーまたは通常のコンテナーの名前は、すべてのコンテナー間で一意である必要があります。Init コンテナーには、ライフサイクルアクション、準備プローブ、ライブネスプローブ、またはスタートアッププローブがない場合があります。init コンテナーの resourceRequirements は、各リソースタイプの最大の要求/制限を見つけ、その値の最大値または通常のコンテナーの合計を使用することにより、スケジューリング中に考慮されます。同様の方法で、init コンテナーに制限が適用されます。現在、初期化コンテナーを追加または削除することはできません。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
- 型
-
array
3.1.241. .spec.install.spec.deployments[].spec.template.spec.initContainers[]
- 説明
- Pod 内で実行する単一のアプリケーションコンテナー。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| エントリーポイントへの引数。これが指定されていない場合は、コンテナーイメージの 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 |
|
| エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、コンテナーイメージの 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 |
|
| コンテナーに設定する環境変数のリスト。これを更新することはできません。 |
|
| EnvVar は、コンテナーに存在する環境変数を表します。 |
|
| コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。 |
|
| EnvFromSource は、一連の ConfigMap のソースを表します |
|
| コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。 |
|
| イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images |
|
| コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これを更新することはできません。 |
|
| コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| DNS_LABEL として指定されたコンテナーの名前。Pod 内の各コンテナーには、一意の名前 (DNS_LABEL) が必要です。これを更新することはできません。 |
|
| コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これを更新することはできません。 |
|
| ContainerPort は、単一のコンテナー内のネットワークポートを表します。 |
|
| コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| このコンテナーに必要なコンピューティングリソース。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
| SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
|
| StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。 |
|
| コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。 |
|
| オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。 |
|
| 終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。 |
|
| このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。 |
|
| volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。 |
|
| volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。 |
|
| コンテナーのファイルシステムにマウントする Pod ボリューム。これを更新することはできません。 |
|
| VolumeMount は、コンテナー内でのボリュームのマウントを説明します。 |
|
| コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。 |
3.1.242. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env
- 説明
- コンテナーに設定する環境変数のリスト。これを更新することはできません。
- 型
-
array
3.1.243. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[]
- 説明
- EnvVar は、コンテナーに存在する環境変数を表します。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 環境変数の名前。C_IDENTIFIER でなければなりません。 |
|
| 変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。 |
|
| 環境変数の値のソースです。値が空でない場合は使用できません。 |
3.1.244. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom
- 説明
- 環境変数の値のソースです。値が空でない場合は使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ConfigMap のキーを選択します。 |
|
|
Pod のフィールドを選択します。metadata.name、metadata.namespace、 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。 |
|
| Pod の namespace でシークレットのキーを選択します |
3.1.245. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.configMapKeyRef
- 説明
- ConfigMap のキーを選択します。
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
3.1.246. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.fieldRef
- 説明
-
Pod のフィールドを選択します。metadata.name、metadata.namespace、
metadata.labels['<KEY>']
、metadata.annotations['<KEY>']
、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs がサポートされています。 - 型
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
3.1.247. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
3.1.248. .spec.install.spec.deployments[].spec.template.spec.initContainers[].env[].valueFrom.secretKeyRef
- 説明
- Pod の namespace でシークレットのキーを選択します
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
3.1.249. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom
- 説明
- コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。
- 型
-
array
3.1.250. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[]
- 説明
- EnvFromSource は、一連の ConfigMap のソースを表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択する ConfigMap |
|
| ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。 |
|
| から選択する秘密 |
3.1.251. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].configMapRef
- 説明
- 選択する ConfigMap
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap を定義する必要があるかどうかを指定します |
3.1.252. .spec.install.spec.deployments[].spec.template.spec.initContainers[].envFrom[].secretRef
- 説明
- から選択する秘密
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットを定義する必要があるかどうかを指定します |
3.1.253. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle
- 説明
- コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これを更新することはできません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
|
| PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
3.1.254. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart
- 説明
- PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
3.1.255. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.256. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.257. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.258. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.259. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.postStart.tcpSocket
- 説明
- 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.260. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop
- 説明
- PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
3.1.261. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.262. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.263. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.264. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.265. .spec.install.spec.deployments[].spec.template.spec.initContainers[].lifecycle.preStop.tcpSocket
- 説明
- 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.266. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe
- 説明
- コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.267. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.268. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.269. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.270. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.271. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.272. .spec.install.spec.deployments[].spec.template.spec.initContainers[].livenessProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.273. .spec.install.spec.deployments[].spec.template.spec.initContainers[].ports
- 説明
- コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これを更新することはできません。
- 型
-
array
3.1.274. .spec.install.spec.deployments[].spec.template.spec.initContainers[].ports[]
- 説明
- ContainerPort は、単一のコンテナー内のネットワークポートを表します。
- 型
-
object
- 必須
-
containerPort
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。 |
|
| 外部ポートをバインドするホスト IP。 |
|
| ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。 |
|
| 指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。 |
|
| ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。 |
3.1.275. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe
- 説明
- コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.276. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.277. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.278. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.279. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.280. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.281. .spec.install.spec.deployments[].spec.template.spec.initContainers[].readinessProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.282. .spec.install.spec.deployments[].spec.template.spec.initContainers[].resources
- 説明
- このコンテナーに必要なコンピューティングリソース。これを更新することはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
3.1.283. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext
- 説明
- SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。 |
|
| コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
|
| コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。 |
3.1.284. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.capabilities
- 説明
- コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 追加された機能 |
|
| 削除された機能 |
3.1.285. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seLinuxOptions
- 説明
- コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Level は、コンテナーに適用される SELinux レベルのラベルです。 |
|
| Role は、コンテナーに適用される SELinux ロールラベルです。 |
|
| Type は、コンテナーに適用される SELinux タイプのラベルです。 |
|
| User は、コンテナーに適用される SELinux ユーザーラベルです。 |
3.1.286. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.seccompProfile
- 説明
- このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。 |
|
| type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。 |
3.1.287. .spec.install.spec.deployments[].spec.template.spec.initContainers[].securityContext.windowsOptions
- 説明
- すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。 |
|
| GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。 |
|
| hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。 |
|
| コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
3.1.288. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe
- 説明
- StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Exec は実行するアクションを指定します。 |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
|
| GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。 |
|
| HTTPGet は、実行する http リクエストを指定します。 |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
|
| TCPSocket は、TCP ポートを含むアクションを指定します。 |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
3.1.289. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.exec
- 説明
- Exec は実行するアクションを指定します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
3.1.290. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.grpc
- 説明
- GRPC は、GRPC ポートに関連するアクションを指定します。これはベータフィールドであり、GRPCContainerProbe 機能ゲートを有効にする必要があります。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
3.1.291. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet
- 説明
- HTTPGet は、実行する http リクエストを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
|
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 |
|
| HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します |
|
| HTTP サーバーでアクセスするパス。 |
|
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。 |
3.1.292. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders
- 説明
- リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。
- 型
-
array
3.1.293. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.httpGet.httpHeaders[]
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ヘッダーフィールド名 |
|
| ヘッダーフィールド値 |
3.1.294. .spec.install.spec.deployments[].spec.template.spec.initContainers[].startupProbe.tcpSocket
- 説明
- TCPSocket は、TCP ポートを含むアクションを指定します。
- 型
-
object
- 必須
-
port
-
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
|
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
3.1.295. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices
- 説明
- volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。
- 型
-
array
3.1.296. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeDevices[]
- 説明
- volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
- 型
-
object
- 必須
-
devicePath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| devicePath は、デバイスがマップされるコンテナー内のパスです。 |
|
| name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります |
3.1.297. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts
- 説明
- コンテナーのファイルシステムにマウントする Pod ボリューム。これを更新することはできません。
- 型
-
array
3.1.298. .spec.install.spec.deployments[].spec.template.spec.initContainers[].volumeMounts[]
- 説明
- VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
- 型
-
object
- 必須
-
mountPath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。 |
|
| mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。 |
|
| ボリュームの名前に一致する必要があります。 |
|
| true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。 |
3.1.299. .spec.install.spec.deployments[].spec.template.spec.os
- 説明
- Pod 内のコンテナーの OS を指定します。これが設定されている場合、一部の Pod およびコンテナーフィールドは制限されます。OS フィールドが Windows に設定されている場合は、次のフィールドの設定を解除する必要があります。- spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.appArmorProfile - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.appArmorProfile - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[].securityContext.runAsGroup
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| name は、オペレーティングシステムの名前です。現在サポートされている値は linux および windows です。今後、追加の値が定義される可能性があり、https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration のいずれかになります。クライアントは、追加の値を処理し、このフィールドで認識されない値を os: null として処理する必要があります。 |
3.1.300. .spec.install.spec.deployments[].spec.template.spec.readinessGates
- 説明
- 指定した場合、すべての準備ゲートが Pod の準備状況に対して評価されます。すべてのコンテナーの準備が整い、準備ゲートで指定されたすべての条件のステータスが "True" になると、Pod の準備が整います。詳細: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
- 型
-
array
3.1.301. .spec.install.spec.deployments[].spec.template.spec.readinessGates[]
- 説明
- PodReadinessGate には、Pod 条件への参照が含まれています
- 型
-
object
- 必須
-
conditionType
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ConditionType は、タイプが一致する Pod の条件リスト内の条件を参照します。 |
3.1.302. .spec.install.spec.deployments[].spec.template.spec.securityContext
- 説明
- SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。オプション: デフォルトは空です。各フィールドのデフォルト値は、タイプの説明を参照してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Pod の全コンテナーに適用される特別な補助グループです。一部のボリュームタイプでは、Kubelet がそのボリュームの所有権を Pod が所有するように変更できます:1。所有する GID は FSGroup2 になります。setgid ビットが設定されます (ボリュームに作成された新しいファイルは FSGroup によって所有されます)3。パーミッションビットは rw-rw と OR されます ---- 設定されていない場合、Kubelet はどのボリュームの所有権とパーミッションも変更しません。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| fsGroupChangePolicy は、Pod 内部で公開する前にボリュームの所有権とアクセス権を変更する動作を定義します。このフィールドは、fsGroup ベースの所有権 (および権限) をサポートするボリュームタイプにのみ適用されます。secret、configmaps、emptydir などのエフェメラルボリュームタイプには影響しません。有効な値は "OnRootMismatch" と "Always" です。指定しない場合は "Always" を使用します。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
|
| コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーのプライマリー GID に加えて、各コンテナーで実行される最初のプロセスに適用されるグループのリスト。指定しない場合、グループはどのコンテナーにも追加されません。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| Sysctl は、設定するカーネルパラメーターを定義します |
|
| すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、コンテナーの SecurityContext 内のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。 |
3.1.303. .spec.install.spec.deployments[].spec.template.spec.securityContext.seLinuxOptions
- 説明
- すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Level は、コンテナーに適用される SELinux レベルのラベルです。 |
|
| Role は、コンテナーに適用される SELinux ロールラベルです。 |
|
| Type は、コンテナーに適用される SELinux タイプのラベルです。 |
|
| User は、コンテナーに適用される SELinux ユーザーラベルです。 |
3.1.304. .spec.install.spec.deployments[].spec.template.spec.securityContext.seccompProfile
- 説明
- この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。 |
|
| type は、適用される seccomp プロファイルの種類を示します。有効なオプションは次のとおりです。Localhost- ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。 |
3.1.305. .spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls
- 説明
- Sysctl は、Pod に使用される namespace 付き sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
- 型
-
array
3.1.306. .spec.install.spec.deployments[].spec.template.spec.securityContext.sysctls[]
- 説明
- Sysctl は、設定するカーネルパラメーターを定義します
- 型
-
object
- 必須
-
name
-
value
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 設定するプロパティーの名前 |
|
| 設定するプロパティーの値 |
3.1.307. .spec.install.spec.deployments[].spec.template.spec.securityContext.windowsOptions
- 説明
- すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、コンテナーの SecurityContext 内のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。 |
|
| GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。 |
|
| hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。 |
|
| コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
3.1.308. .spec.install.spec.deployments[].spec.template.spec.tolerations
- 説明
- 指定されている場合、Pod の許容範囲。
- 型
-
array
3.1.309. .spec.install.spec.deployments[].spec.template.spec.tolerations[]
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。 |
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
3.1.310. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints
- 説明
- TopologySpreadConstraints は、Pod のグループがトポロジードメイン全体にどのように分散するべきかを説明します。スケジューラーは、制約に従う方法で Pod をスケジュールします。すべての topologySpreadConstraints は AND 演算されます。
- 型
-
array
3.1.311. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[]
- 説明
- topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。
- 型
-
object
- 必須
-
maxSkew
-
topologyKey
-
whenUnsatisfiable
-
プロパティー | 型 | 説明 |
---|---|---|
|
| LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。 |
|
| MatchLabelKeys は、分散を計算する Pod を選択するための Pod ラベルキーのセットです。このようなキーは受信 Pod のラベルから値を検索するために使用され、このキーと値のラベルは labelSelector と AND 演算されて、受信 Pod の分散が計算される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。 |
|
|
MaxSkew は、Pod が不均一に分布している可能性の程度を表します。 |
|
| 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 は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。この値が nil の場合、この動作は Honor ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。 |
|
| NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。この値が nil の場合、この動作は Ignore ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによって有効にされるアルファレベルの機能です。 |
|
| TopologyKey は、ノードラベルのキーです。このキーと同じ値のラベルを持つノードは、同じトポロジーにあると見なされます。各 <key, value> を "バケット" と見なし、バランスの取れた数の Pod を各バケットに配置しようとします。ドメインをトポロジーの特定のインスタンスとして定義します。また、ノードが nodeAffinityPolicy および nodeTaintsPolicy の要件を満たすドメインとして、適格なドメインを定義します。たとえば、TopologyKey が "kubernetes.io/hostname" の場合、各ノードはそのトポロジーのドメインです。また、TopologyKey が "topology.kubernetes.io/zone" の場合は、各ゾーンがそのトポロジーのドメインになります。必須フィールドです。 |
|
| 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) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。 |
3.1.312. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector
- 説明
- LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.313. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.314. .spec.install.spec.deployments[].spec.template.spec.topologySpreadConstraints[].labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.315. .spec.install.spec.deployments[].spec.template.spec.volumes
- 説明
- Pod に属するコンテナーによってマウントできるボリュームのリスト。詳細: https://kubernetes.io/docs/concepts/storage/volumes
- 型
-
array
3.1.316. .spec.install.spec.deployments[].spec.template.spec.volumes[]
- 説明
- ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。 |
|
| azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。 |
|
| cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。 |
|
| Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| configMap は、このボリュームに入力する必要がある configMap を表します |
|
| csi (Container Storage Interface) は、特定の外部 CSI ドライバー (ベータ機能) によって処理される一時的なストレージを表します。 |
|
| downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します |
|
| emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
| ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。 |
|
| fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。 |
|
| flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。 |
|
| flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります |
|
| gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。 |
|
| glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md |
|
| hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。 |
|
| iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md |
|
| ボリュームの名前。DNS_LABEL であり、Pod 内で一意である必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
| photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。 |
|
| portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。 |
|
| オールインワンリソースシークレット、configmaps、および Downward API のアイテム |
|
| quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します |
|
| rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md |
|
| scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。 |
|
| secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
| storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。 |
|
| vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。 |
3.1.317. .spec.install.spec.deployments[].spec.template.spec.volumes[].awsElasticBlockStore
- 説明
- awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。 |
|
| readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
3.1.318. .spec.install.spec.deployments[].spec.template.spec.volumes[].azureDisk
- 説明
- azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
- 型
-
object
- 必須
-
diskName
-
diskURI
-
プロパティー | 型 | 説明 |
---|---|---|
|
| cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。 |
|
| diskName は、Blob ストレージ内のデータディスクの名前です。 |
|
| diskURI は、BLOB ストレージ内のデータディスクの URI です |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。 |
|
| readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
3.1.319. .spec.install.spec.deployments[].spec.template.spec.volumes[].azureFile
- 説明
- azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
- 型
-
object
- 必須
-
secretName
-
shareName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。 |
|
| shareName は Azure 共有名です。 |
3.1.320. .spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs
- 説明
- cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。
- 型
-
object
- 必須
-
monitors
-
プロパティー | 型 | 説明 |
---|---|---|
|
| monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| user 任意: User は rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
3.1.321. .spec.install.spec.deployments[].spec.template.spec.volumes[].cephfs.secretRef
- 説明
- secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.322. .spec.install.spec.deployments[].spec.template.spec.volumes[].cinder
- 説明
- Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。 |
|
| cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
3.1.323. .spec.install.spec.deployments[].spec.template.spec.volumes[].cinder.secretRef
- 説明
- secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.324. .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap
- 説明
- configMap は、このボリュームに入力する必要がある configMap を表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| 任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
3.1.325. .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items
- 説明
- item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
3.1.326. .spec.install.spec.deployments[].spec.template.spec.volumes[].configMap.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
3.1.327. .spec.install.spec.deployments[].spec.template.spec.volumes[].csi
- 説明
- csi (Container Storage Interface) は、特定の外部 CSI ドライバー (ベータ機能) によって処理される一時的なストレージを表します。
- 型
-
object
- 必須
-
driver
-
プロパティー | 型 | 説明 |
---|---|---|
|
| driver は、このボリュームを処理する CSI ドライバーの名前です。クラスターに登録されている正しい名前は、管理者に相談してください。 |
|
| マウントする fsType。例: "ext4"、"xfs"、"ntfs"。指定しない場合、空の値が関連する CSI ドライバーに渡され、適用するデフォルトのファイルシステムが決定されます。 |
|
| nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。 |
|
| readOnly は、ボリュームの読み取り専用設定を指定します。デフォルトは false (読み取り/書き込み) です。 |
|
| volumeAttributes は、CSI ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。 |
3.1.328. .spec.install.spec.deployments[].spec.template.spec.volumes[].csi.nodePublishSecretRef
- 説明
- nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.329. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI
- 説明
- downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: デフォルトで作成されたファイルで使用するモードビット。オプション: デフォルトで作成されたファイルのパーミッションを設定するために使用されるモードビット。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| items は、Downward API ボリュームファイルのリストです |
|
| DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します |
3.1.330. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items
- 説明
- items は、Downward API ボリュームファイルのリストです
- 型
-
array
3.1.331. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[]
- 説明
- DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。 |
|
| オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| 必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。 |
3.1.332. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].fieldRef
- Description
- 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
- タイプ
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
3.1.333. .spec.install.spec.deployments[].spec.template.spec.volumes[].downwardAPI.items[].resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
3.1.334. .spec.install.spec.deployments[].spec.template.spec.volumes[].emptyDir
- 説明
- emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| medium は、このディレクトリーをバックアップする必要があるストレージメディアのタイプを表します。デフォルトは"" です。これは、ノードのデフォルトのメディアを使用することを意味します。空の文字列 (デフォルト) またはメモリーである必要があります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
| sizeLimit は、この EmptyDir ボリュームに必要なローカルストレージの合計量です。サイズ制限はメモリーメディアにも適用されます。メモリーメディア EmptyDir での最大使用量は、ここで指定された SizeLimit と Pod 内のすべてのコンテナーのメモリー制限の合計との間の最小値になります。デフォルトは nil です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir |
3.1.335. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral
- 説明
- ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は |
3.1.336. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate
- 説明
-
ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は
<pod name>-<volume name>
になります。ここで、<volume name>
はPodSpec.Volumes
アレイエントリーからの名前です。連結された名前が PVC に対して有効でない場合 (たとえば、長すぎる場合)、Pod 検証は Pod を拒否します。Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。必須です。nil であってはなりません。 - 型
-
object
- 必須
-
spec
-
プロパティー | 型 | 説明 |
---|---|---|
|
| PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。 |
|
| PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。 |
3.1.337. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.metadata
- 説明
- PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
- 型
-
object
3.1.338. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec
- 説明
- PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
|
| dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。 |
|
| dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
|
| resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector は、バインドを考慮するボリュームに対するラベルクエリーです。 |
|
| storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
| volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。 |
|
| volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。 |
3.1.339. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource
- 説明
- dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
- タイプ
-
object
- 必須
-
kind
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
3.1.340. .spec.install.spec.deployments[].spec.template.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
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
3.1.341. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources
- 説明
- resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
3.1.342. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector
- 説明
- selector は、バインドを考慮するボリュームに対するラベルクエリーです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.343. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.344. .spec.install.spec.deployments[].spec.template.spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.345. .spec.install.spec.deployments[].spec.template.spec.volumes[].fc
- 説明
- fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。TODO: ファイルシステムのエラーがマシンを危険にさらすのを防ぐにはどうすればよいですか ? |
|
| LUN は任意: FC ターゲットの LUN 番号 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN) |
|
| wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。 |
3.1.346. .spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume
- 説明
- flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。
- 型
-
object
- 必須
-
driver
-
プロパティー | 型 | 説明 |
---|---|---|
|
| driver は、このボリュームに使用するドライバーの名前です。 |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。 |
|
| options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。 |
3.1.347. .spec.install.spec.deployments[].spec.template.spec.volumes[].flexVolume.secretRef
- 説明
- secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.348. .spec.install.spec.deployments[].spec.template.spec.volumes[].flocker
- 説明
- flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。 |
|
| datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です |
3.1.349. .spec.install.spec.deployments[].spec.template.spec.volumes[].gcePersistentDisk
- 説明
- gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- 型
-
object
- 必須
-
pdName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
3.1.350. .spec.install.spec.deployments[].spec.template.spec.volumes[].gitRepo
- 説明
- gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。
- 型
-
object
- 必須
-
repository
-
プロパティー | 型 | 説明 |
---|---|---|
|
| directory は、ターゲットディレクトリー名です。'..' を含まない、または..で始まらないようにする必要があります。もしも '。' が提供されている場合、ボリュームディレクトリーは git リポジトリーになります。それ以外の場合、指定されている場合、ボリュームには、指定された名前のサブディレクトリーに git リポジトリーが含まれます。 |
|
| repository は URL です。 |
|
| revision は、指定されたリビジョンのコミットハッシュです。 |
3.1.351. .spec.install.spec.deployments[].spec.template.spec.volumes[].glusterfs
- 説明
- glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md
- 型
-
object
- 必須
-
endpoints
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
3.1.352. .spec.install.spec.deployments[].spec.template.spec.volumes[].hostPath
- 説明
- hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
3.1.353. .spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi
- 説明
- iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md
- 型
-
object
- 必須
-
iqn
-
lun
-
targetPortal
-
プロパティー | 型 | 説明 |
---|---|---|
|
| chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。 |
|
| chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。 |
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。 |
|
| iqn は、ターゲットの iSCSI 修飾名です。 |
|
| iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。 |
|
| lun は、iSCSI ターゲット Lun 番号を表します。 |
|
| ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。 |
|
| secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。 |
|
| targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
3.1.354. .spec.install.spec.deployments[].spec.template.spec.volumes[].iscsi.secretRef
- 説明
- secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.355. .spec.install.spec.deployments[].spec.template.spec.volumes[].nfs
- 説明
- NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 型
-
object
- 必須
-
path
-
server
-
プロパティー | 型 | 説明 |
---|---|---|
|
| NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
3.1.356. .spec.install.spec.deployments[].spec.template.spec.volumes[].persistentVolumeClaim
- 説明
- persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 型
-
object
- 必須
-
claimName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| claimName は、このボリュームを使用する Pod と同じ namespace にある PersistentVolumeClaim の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
| readOnly は、VolumeMounts の ReadOnly 設定が強制的に指定されます。デフォルト: false |
3.1.357. .spec.install.spec.deployments[].spec.template.spec.volumes[].photonPersistentDisk
- 説明
- photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。
- 型
-
object
- 必須
-
pdID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| pdID は、Photon Controller の永続ディスクを識別する ID です。 |
3.1.358. .spec.install.spec.deployments[].spec.template.spec.volumes[].portworxVolume
- 説明
- portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| volumeID は、Portworx ボリュームを一意に識別します |
3.1.359. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected
- 説明
- オールインワンリソースシークレット、configmaps、および Downward API のアイテム
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| defaultMode は、作成されたファイルにデフォルトでアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| source は、ボリュームプロジェクションのリストです。 |
|
| サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション |
3.1.360. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources
- 説明
- source は、ボリュームプロジェクションのリストです。
- 型
-
array
3.1.361. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[]
- 説明
- サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| プロジェクトへの configMap データの onfigMap 情報 |
|
| downwardAPI データのプロジェクトへの downwardAPI 情報 |
|
| 投影するシークレットデータに関する情報 |
|
| serviceAccountToken は、投影する serviceAccountToken データに関する情報です。 |
3.1.362. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap
- 説明
- プロジェクトへの configMap データの onfigMap 情報
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| 任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
3.1.363. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items
- 説明
- item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
3.1.364. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].configMap.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
3.1.365. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI
- 説明
- downwardAPI データのプロジェクトへの downwardAPI 情報
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Items は DownwardAPIVolume ファイルのリストです |
|
| DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します |
3.1.366. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items
- 説明
- Items は DownwardAPIVolume ファイルのリストです
- 型
-
array
3.1.367. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[]
- 説明
- DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。 |
|
| オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| 必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。 |
3.1.368. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef
- Description
- 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
- タイプ
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
3.1.369. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
3.1.370. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret
- 説明
- 投影するシークレットデータに関する情報
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。 |
3.1.371. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items
- 説明
- items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
3.1.372. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].secret.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
3.1.373. .spec.install.spec.deployments[].spec.template.spec.volumes[].projected.sources[].serviceAccountToken
- 説明
- serviceAccountToken は、投影する serviceAccountToken データに関する情報です。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| audience は、トークンの対象オーディエンスです。トークンの受信者は、トークンのオーディエンスで指定された識別子で自分自身を識別する必要があります。そうでない場合は、トークンを拒否する必要があります。対象はデフォルトで API サーバーの識別子に設定されます。 |
|
| expirationSeconds は、サービスアカウントトークンの要求された有効期間です。トークンの有効期限が近づくと、kubelet ボリュームプラグインはサービスアカウントトークンをプロアクティブにローテーションします。トークンが存続時間の 80% より古い場合、またはトークンが 24 時間より古い場合、kubelet はトークンのローテーションを開始します。デフォルトは 1 時間で、少なくとも 10 分である必要があります。 |
|
| path は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。 |
3.1.374. .spec.install.spec.deployments[].spec.template.spec.volumes[].quobyte
- 説明
- quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します
- 型
-
object
- 必須
-
registry
-
volume
-
プロパティー | 型 | 説明 |
---|---|---|
|
| アクセスできるボリュームをマップするグループ。デフォルトは no group です。 |
|
| ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。 |
|
| registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。 |
|
| 動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。 |
|
| アクセスできるボリュームをマップするグループ。デフォルトは serivceaccount user です。 |
|
| volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。 |
3.1.375. .spec.install.spec.deployments[].spec.template.spec.volumes[].rbd
- 説明
- rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md
- 型
-
object
- 必須
-
image
-
monitors
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
3.1.376. .spec.install.spec.deployments[].spec.template.spec.volumes[].rbd.secretRef
- 説明
- secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.377. .spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO
- 説明
- scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。
- 型
-
object
- 必須
-
gateway
-
secretRef
-
system
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。 |
|
| gateway は、ScaleIO API ゲートウェイのホストアドレスです。 |
|
| protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。 |
|
| readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。 |
|
| sslEnabled Flag は、ゲートウェイとの SSL 通信を有効/無効にします。デフォルトは false です |
|
| storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。 |
|
| storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。 |
|
| system は、ScaleIO で設定されたストレージシステムの名前です。 |
|
| volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。 |
3.1.378. .spec.install.spec.deployments[].spec.template.spec.volumes[].scaleIO.secretRef
- 説明
- secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.379. .spec.install.spec.deployments[].spec.template.spec.volumes[].secret
- 説明
- secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| optional フィールド。シークレットかそのキーを定義する必要があるかどうかを指定します。 |
|
| secretName は、使用する Pod の namespace 内のシークレットの名前です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret |
3.1.380. .spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items
- 説明
- items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
3.1.381. .spec.install.spec.deployments[].spec.template.spec.volumes[].secret.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
3.1.382. .spec.install.spec.deployments[].spec.template.spec.volumes[].storageos
- 説明
- storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。 |
|
| volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は、ネームスペース内でのみ一意です。 |
|
| volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない名前空間が作成されます。 |
3.1.383. .spec.install.spec.deployments[].spec.template.spec.volumes[].storageos.secretRef
- 説明
- secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
3.1.384. .spec.install.spec.deployments[].spec.template.spec.volumes[].vsphereVolume
- 説明
- vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。
- 型
-
object
- 必須
-
volumePath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| storagePolicyID は、StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID です。 |
|
| storagePolicyName は、ストレージポリシーベースの管理 (SPBM) プロファイル名です。 |
|
| volumePath は、vSphere ボリューム vmdk を識別するパスです。 |
3.1.385. .spec.install.spec.permissions
- 説明
- 型
-
array
3.1.386. .spec.install.spec.permissions[]
- 説明
- StrategyDeploymentPermissions は、インストール戦略に必要な rbac ルールとサービスアカウントを記述します
- 型
-
object
- 必須
-
rules
-
serviceAccountName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。 |
|
|
3.1.387. .spec.install.spec.permissions[].rules
- 説明
- 型
-
array
3.1.388. .spec.install.spec.permissions[].rules[]
- 説明
- PolicyRule は、ポリシールールを説明する情報を保持しますが、ルールが適用されるユーザーやルールが適用される namespace に関する情報は含まれません。
- 型
-
object
- 必須
-
verbs
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroups は、リソースを含む APIGroup の名前です。複数の API グループが指定されている場合、任意の API グループ内の列挙されたリソースの 1 つに対してリクエストされたアクションはすべて許可されます。"" はコア API グループを表し、"*" はすべての API グループを表します。 |
|
| NonResourceURLs は、ユーザーがアクセスできる必要のある部分的な URL のセットです。*は許可されますが、パスの完全な最終ステップとしてのみです。非リソース URL は名前空間化されていないため、このフィールドは ClusterRoleBinding から参照される ClusterRoles にのみ適用されます。ルールは、API リソース ("pods" や "secrets" など) または非リソース URL パス ("/api" など) のいずれかに適用できますが、両方に適用することはできません。 |
|
| resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。 |
|
| リソースは、このルールが適用されるリソースのリストです。'*' はすべてのリソースを表します。 |
|
| Verbs は、このルールに含まれるすべての ResourceKind に適用される Verbs のリストです。'*' はすべての動詞を表します。 |
3.1.389. .spec.installModes
- 説明
- InstallModes は、サポートされているインストールタイプを指定します
- 型
-
array
3.1.390. .spec.installModes[]
- 説明
- InstallMode は、InstallModeType を CSV がサポートするかどうかを表すフラグに関連付けます。
- 型
-
object
- 必須
-
supported
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| InstallModeType は、CSV インストールでサポートされているタイプのインストールモードです。 |
3.1.391. .spec.links
- Description
- 型
-
array
3.1.392. .spec.links[]
- 説明
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
3.1.393. .spec.maintainers
- Description
- 型
-
array
3.1.394. .spec.maintainers[]
- 説明
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
3.1.395. .spec.nativeAPIs
- 説明
- 型
-
array
3.1.396. .spec.nativeAPIs[]
- 説明
- GroupVersionKind では、kind をあいまいに識別します。自動的な強制変換を回避するために、GroupVersion を匿名で含めていません。カスタムマーシャリングを回避するために GroupVersion を使用しません。
- 型
-
object
- 必須
-
group
-
kind
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
3.1.397. .spec.provider
- Description
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
3.1.400. .spec.selector
- 説明
- 関連リソースのラベルセレクター。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.401. .spec.selector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.402. .spec.selector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.403. .spec.webhookdefinitions
- 説明
- 型
-
array
3.1.404. .spec.webhookdefinitions[]
- 説明
- WebhookDescription は、必要な Webhook に関する詳細を OLM に提供します
- 型
-
object
- 必須
-
admissionReviewVersions
-
generateName
-
sideEffects
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| FailurePolicyType は、アドミッションエンドポイントからの認識されないエラーの処理方法を定義する失敗ポリシーを指定します。 |
|
| |
|
| MatchPolicyType は、一致ポリシーのタイプを指定します。 |
|
| ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。 |
|
| ReinvocationPolicyType は、アドミッションフックが使用するポリシーのタイプを指定します。 |
|
| |
|
| RuleWithOperations は、操作とリソースのタプルです。すべてのタプル拡張が有効であることを確認することを推奨します。 |
|
| SideEffectClass は、Webhook が持つ可能性のある副作用のタイプを指定します。 |
|
| |
|
| |
|
| WebhookAdmissionType は、OLM でサポートされているアドミッション Webhook のタイプです。 |
|
|
3.1.405. .spec.webhookdefinitions[].objectSelector
- 説明
- ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
3.1.406. .spec.webhookdefinitions[].objectSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
3.1.407. .spec.webhookdefinitions[].objectSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
3.1.408. .spec.webhookdefinitions[].rules
- 説明
- 型
-
array
3.1.409. .spec.webhookdefinitions[].rules[]
- 説明
- RuleWithOperations は、操作とリソースのタプルです。すべてのタプル拡張が有効であることを確認することを推奨します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroups は、リソースが属する API グループです。'' はすべてのグループです。もしも '' が存在する場合、スライスの長さは 1 でなければなりません。必須。 |
|
| APIVersions は、リソースが属する API バージョンです。'' はすべてのバージョンです。もしも '' が存在する場合、スライスの長さは 1 でなければなりません。必須。 |
|
| 操作は、アドミッションフックが気にする操作です - これらすべての操作および追加される将来のアドミッション操作に対して、CREATE、UPDATE、DELETE、CONNECT、または*。'*' が存在する場合、スライスの長さは 1 でなければなりません。必須。 |
|
| リソースは、このルールが適用されるリソースのリストです。例: 'Pod' は Pod を意味します。'pods/log' は、Pod のログサブリソースを意味します。'' はすべてのリソースを意味しますが、サブリソースは意味しません。'pods/' は、Pod のすべてのサブリソースを意味します。'/scale' は、すべてのスケールサブリソースを意味します。'/*' は、すべてのリソースとそのサブリソースを意味します。ワイルドカードが存在する場合、検証ルールはリソースが互いに重複しないことを保証します。囲んでいるオブジェクトによっては、サブリソースが許可されない場合があります。必須。 |
|
| scope は、このルールのスコープを指定します。有効な値は、"Cluster"、"Namespaced"、および "" "クラスター" とは、クラスタースコープのリソースのみがこのルールに一致することを意味します。名前空間 API オブジェクトはクラスタースコープです。"Namespaced" は、名前空間付きのリソースのみがこのルールに一致することを意味します。"" は、スコープの制限がないことを意味します。サブリソースは、親リソースのスコープと一致します。デフォルトは "*" です。 |
3.1.410. .status
- 説明
- ClusterServiceVersionStatus は、CSV のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 所有している APIService 証明書が最後に更新されたとき |
|
| 所有する APIService 証明書が次にローテーションする時間 |
|
| CleanupStatus は、CSV が削除を保留している間のクリーンアップのステータスに関する情報を表します |
|
| 条件のリスト、状態遷移の履歴 |
|
| 条件は、ClusterServiceVersion の状態遷移のレコードとしてステータスに表示されます |
|
| 前回、ステータスがあるステータスから別のステータスに移行したとき。 |
|
| 前回ステータスを更新しました |
|
| ClusterServiceVersion がこの状態にある理由の詳細を示す人間が読めるメッセージ。 |
|
| ClusterServiceVersion の現在の状態 |
|
| ClusterServiceVersion がこの状態にある理由の詳細を示す簡単な CamelCase メッセージ。例えば'RequirementsNotMet' |
|
| この CSV の各要件のステータス |
|
|
3.1.411. .status.cleanup
- 説明
- CleanupStatus は、CSV が削除を保留している間のクリーンアップのステータスに関する情報を表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| pendingDeletion は、削除が保留され、ファイナライザーでブロックされているカスタムリソースオブジェクトのリストです。これは、CSV の削除または Operator のアンインストールをブロックしているクリーンアップの進行状況を示します。 |
|
| ResourceList は、同じグループ/種類のリソースのリストを表します |
3.1.412. .status.cleanup.pendingDeletion
- 説明
- pendingDeletion は、削除が保留され、ファイナライザーでブロックされているカスタムリソースオブジェクトのリストです。これは、CSV の削除または Operator のアンインストールをブロックしているクリーンアップの進行状況を示します。
- 型
-
array
3.1.413. .status.cleanup.pendingDeletion[]
- 説明
- ResourceList は、同じグループ/種類のリソースのリストを表します
- 型
-
object
- 必須
-
group
-
instances
-
kind
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
|
3.1.414. .status.cleanup.pendingDeletion[].instances
- 説明
- 型
-
array
3.1.415. .status.cleanup.pendingDeletion[].instances[]
- 説明
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| クラスタースコープのリソースの名前空間は空にすることができます |
3.1.416. .status.conditions
- 説明
- 条件のリスト、状態遷移の履歴
- 型
-
array
3.1.417. .status.conditions[]
- 説明
- 条件は、ClusterServiceVersion の状態遷移のレコードとしてステータスに表示されます
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 前回、ステータスがあるステータスから別のステータスに移行したとき。 |
|
| 前回ステータスを更新しました |
|
| ClusterServiceVersion がこの状態にある理由の詳細を示す人間が読めるメッセージ。 |
|
| ClusterServiceVersion の条件 |
|
| ClusterServiceVersion がこの状態にある理由の詳細を示す簡単な CamelCase メッセージ。例えば'RequirementsNotMet' |
3.1.418. .status.requirementStatus
- 説明
- この CSV の各要件のステータス
- 型
-
array
3.1.419. .status.requirementStatus[]
- 説明
- 型
-
object
- 必須
-
group
-
kind
-
message
-
name
-
status
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| DependentStatus は、依存要件のステータスです (無限のネストを防ぐため)。 |
|
| |
|
| |
|
| |
|
| |
|
| StatusReason は、RequirementStatus または DependentStatus のステータスのキャメルケースの理由です。 |
|
| |
|
|
3.1.420. .status.requirementStatus[].dependents
- 説明
- 型
-
array
3.1.421. .status.requirementStatus[].dependents[]
- 説明
- DependentStatus は、依存要件のステータスです (無限のネストを防ぐため)。
- 型
-
object
- 必須
-
group
-
kind
-
status
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| StatusReason は、RequirementStatus または DependentStatus のステータスのキャメルケースの理由です。 |
|
| |
|
|
3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v1alpha1/clusterserviceversions
-
GET
: kind が ClusterServiceVersion のオブジェクトをリスト表示します。
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions
-
DELETE
:ClusterServiceVersion のコレクションを削除します -
GET
: kind が ClusterServiceVersion のオブジェクトをリスト表示します。 -
POST
:ClusterServiceVersion を作成します
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}
-
DELETE
: ClusterServiceVersion を削除します。 -
GET
: 指定された ClusterServiceVersion を読み取ります -
PATCH
: 指定された ClusterServiceVersion を部分的に更新します -
PUT
: 指定された ClusterServiceVersion を置き換えます
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status
-
GET
: 指定された ClusterServiceVersion のステータスを読み取ります -
PATCH
: 指定された ClusterServiceVersion のステータスを部分的に更新します -
PUT
: 指定された ClusterServiceVersion のステータスを置き換えます
-
3.2.1. /apis/operators.coreos.com/v1alpha1/clusterserviceversions
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が ClusterServiceVersion のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
3.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ClusterServiceVersion のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- ClusterServiceVersion の種類のオブジェクトをリスト表示します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- ClusterServiceVersion を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
3.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ClusterServiceVersion の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ClusterServiceVersion を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された ClusterServiceVersion を読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された ClusterServiceVersion を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された ClusterServiceVersion を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
3.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/clusterserviceversions/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| ClusterServiceVersion の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された ClusterServiceVersion のステータスを読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された ClusterServiceVersion のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された ClusterServiceVersion のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
第4章 InstallPlan [operators.coreos.com/v1alpha1]
- 説明
- InstallPlan は、一連の Operator のインストールを定義します。
- 型
-
object
- 必須
-
metadata
-
spec
-
4.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| InstallPlanSpec は、インストールするアプリケーションリソースのセットを定義します |
|
| InstallPlanStatus は、インストールを完了するために必要な手順のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。 |
4.1.1. .spec
- 説明
- InstallPlanSpec は、インストールするアプリケーションリソースのセットを定義します
- 型
-
object
- 必須
-
approval
-
承認
-
clusterServiceVersionNames
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 承認は、InstallPlan のユーザー認可ポリシーです。"Automatic" または "Manual" のいずれかである必要があります。 |
|
| |
|
| |
|
| |
|
| |
|
|
4.1.2. .status
- 説明
- InstallPlanStatus は、インストールを完了するために必要な手順のステータスに関する情報を表します。ステータスは、システムの実際の状態を追跡する場合があります。
- 型
-
object
- 必須
-
catalogSources
-
phase
-
プロパティー | 型 | 説明 |
---|---|---|
|
| AttenuatedServiceAccountRef は、スコープ Operator のインストールを行うために使用されるサービスアカウントを参照します。 |
|
| BundleLookups は、バンドルコンテンツをクラスターにプルおよびアンパッケージするための進行中のリクエストのセットです。 |
|
| BundleLookup は、バンドルのコンテンツをクラスターにプルしてアンパッケージするためのリクエストです。 |
|
| |
|
| |
|
| InstallPlanCondition は、InstallPlan の実行の全体的なステータスを表します。 |
|
| メッセージは、計画が現在のステータスになっている理由を理解するために重要な詳細情報を含む、人間が読めるメッセージです。 |
|
| InstallPlanPhase は、InstallPlan 全体の現在のステータスです。 |
|
| |
|
| ステップは、InstallPlan の個々のステップのステータスを表します。 |
|
| StartTime は、コントローラーがプランにリストされているリソースをクラスターに適用し始めた時刻です。 |
4.1.3. .status.attenuatedServiceAccountRef
- 説明
- AttenuatedServiceAccountRef は、スコープ Operator のインストールを行うために使用されるサービスアカウントを参照します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
4.1.4. .status.bundleLookups
- 説明
- BundleLookups は、バンドルコンテンツをクラスターにプルおよびアンパッケージするための進行中のリクエストのセットです。
- 型
-
array
4.1.5. .status.bundleLookups[]
- 説明
- BundleLookup は、バンドルのコンテンツをクラスターにプルしてアンパッケージするためのリクエストです。
- 型
-
object
- 必須
-
catalogSourceRef
-
identifier
-
path
-
replaces
-
プロパティー | 型 | 説明 |
---|---|---|
|
| CatalogSourceRef は、バンドルパスが解決された CatalogSource への参照です。 |
|
| 条件は、BundleLookup の全体的な状態を表します。 |
|
| |
|
| 識別子は、カタログ固有の Operator 名 (CSV を含むバンドルの CSV 名) です。 |
|
| パスは、プルするバンドルの場所を指します。これは通常、イメージ参照です。 |
|
| 開梱されたバンドルの有効なプロパティー。 |
|
| Replaces は、Path で見つかったものと置き換えるバンドルの名前です。 |
4.1.6. .status.bundleLookups[].catalogSourceRef
- 説明
- CatalogSourceRef は、バンドルパスが解決された CatalogSource への参照です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
4.1.7. .status.bundleLookups[].conditions
- 説明
- 条件は、BundleLookup の全体的な状態を表します。
- 型
-
array
4.1.8. .status.bundleLookups[].conditions[]
- 説明
- 型
-
object
- 必須
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 最後にある状態から別の状態に遷移した時間。 |
|
| 前回、状態が調査されました。 |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| 状態のタイプ。 |
4.1.9. .status.conditions
- 説明
- 型
-
array
4.1.10. .status.conditions[]
- 説明
- InstallPlanCondition は、InstallPlan の実行の全体的なステータスを表します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| ConditionReason は、状態遷移のキャメルケースの理由です。 |
|
| |
|
| InstallPlanConditionType は、全体として特定の時点での InstallPlan の状態を記述します。 |
4.1.11. .status.plan
- 説明
- 型
-
array
4.1.12. .status.plan[]
- 説明
- ステップは、InstallPlan の個々のステップのステータスを表します。
- 型
-
object
- 必須
-
resolving
-
resource
-
status
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| StepResource は、InstallPlan によって追跡されるリソースのステータスを表します。 |
|
| StepStatus は、InstallPlan 内の特定のリソースの現在のステータスです。 |
4.1.13. .status.plan[].resource
- 説明
- StepResource は、InstallPlan によって追跡されるリソースのステータスを表します。
- 型
-
object
- 必須
-
group
-
kind
-
name
-
sourceName
-
sourceNamespace
-
version
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
4.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v1alpha1/installplans
-
GET
: kind が InstallPlan のオブジェクトをリスト表示します。
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans
-
DELETE
: InstallPlan のコレクションを削除します。 -
GET
: kind が InstallPlan のオブジェクトをリスト表示します。 -
POST
:InstallPlan を作成します
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}
-
DELETE
: InstallPlan を削除します。 -
GET
: 指定された InstallPlan を読み取ります -
PATCH
: 指定された InstallPlan を部分的に更新します -
PUT
: 指定された InstallPlan を置き換えます
-
/apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status
-
GET
: 指定された InstallPlan のステータスを読み取ります -
PATCH
: 指定された InstallPlan のステータスを部分的に更新します -
PUT
: 指定された InstallPlan のステータスを置き換えます
-
4.2.1. /apis/operators.coreos.com/v1alpha1/installplans
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が InstallPlan のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
4.2.2. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- InstallPlan のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- InstallPlan の種類のオブジェクトをリスト表示します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- InstallPlan を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
4.2.3. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| InstallPlan の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- InstallPlan を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された InstallPlan を読みます
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された InstallPlan を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された InstallPlan を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
4.2.4. /apis/operators.coreos.com/v1alpha1/namespaces/{namespace}/installplans/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| InstallPlan の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された InstallPlan のステータスを読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された InstallPlan のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された InstallPlan のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第5章 OLMConfig [operators.coreos.com/v1]
- 説明
- OLMConfig は、OLM の設定を担うリソースです。
- 型
-
object
- 必須
-
metadata
-
5.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| OLMConfigSpec は、OLMConfig リソースの仕様です。 |
|
| OLMConfigStatus は、OLMConfig リソースのステータスです。 |
5.1.1. .spec
- 説明
- OLMConfigSpec は、OLMConfig リソースの仕様です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Features は、設定可能な OLM の機能のリストを格納します。 |
5.1.2. .spec.features
- 説明
- Features は、設定可能な OLM の機能のリストを格納します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| DisableCopiedCSVs は、クラスタースコープでインストールされた Operator の OLM の "Copied CSV" 機能を無効にするために使用されます。クラスタースコープの Operator とは、すべての namespace を対象とする OperatorGroup にインストールされている Operator です。再度有効にすると、OLM によって各クラスタースコープの Operator の "Copied CSV" が再作成されます。 |
5.1.3. .status
- 説明
- OLMConfigStatus は、OLMConfig リソースのステータスです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
5.1.4. .status.conditions
- 説明
- 型
-
array
5.1.5. .status.conditions[]
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields } - 型
-
object
- 必須
-
lastTransitionTime
-
message
-
reason
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
5.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v1/olmconfigs
-
DELETE
: OLMConfig のコレクションを削除します。 -
GET
: kind が OLMConfig のオブジェクトをリスト表示します。 -
POST
: OLMConfig を作成します。
-
/apis/operators.coreos.com/v1/olmconfigs/{name}
-
DELETE
: OLMConfig を削除します。 -
GET
: 指定された OLMConfig を読み取ります。 -
PATCH
: 指定された OLMConfig を部分的に更新します。 -
PUT
: 指定された OLMConfig を置き換えます。
-
/apis/operators.coreos.com/v1/olmconfigs/{name}/status
-
GET
: 指定された OLMConfig のステータスを読み取ります。 -
PATCH
: 指定された OLMConfig のステータスを部分的に更新します。 -
PUT
: 指定された OLMConfig のステータスを置き換えます。
-
5.2.1. /apis/operators.coreos.com/v1/olmconfigs
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- OLMConfig のコレクションを削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- kind が OLMConfig のオブジェクトをリスト表示します。
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- OLMConfig を作成します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
5.2.2. /apis/operators.coreos.com/v1/olmconfigs/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| OLMConfig の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- OLMConfig を削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された OLMConfig を読み取ります。
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された OLMConfig を部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された OLMConfig を置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
5.2.3. /apis/operators.coreos.com/v1/olmconfigs/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| OLMConfig の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された OLMConfig のステータスを読み取ります。
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された OLMConfig のステータスを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された OLMConfig のステータスを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第6章 Operator [operators.coreos.com/v1]
- 説明
- Operator はクラスター Operator を表します。
- 型
-
object
6.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| OperatorSpec は、Operator の望ましい状態を定義します |
|
| OperatorStatus は、Operator とそのコンポーネントの監視状態を定義します |
6.1.1. .spec
- 説明
- OperatorSpec は、Operator の望ましい状態を定義します
- 型
-
object
6.1.2. .status
- 説明
- OperatorStatus は、Operator とそのコンポーネントの監視状態を定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コンポーネントは、Operator を設定するリソースを記述します。 |
6.1.3. .status.components
- 説明
- コンポーネントは、Operator を設定するリソースを記述します。
- 型
-
object
- 必須
-
labelSelector
-
プロパティー | 型 | 説明 |
---|---|---|
|
| LabelSelector は、Operator のコンポーネントを選択するために使用される一連のリソースに対するラベルクエリーです。 |
|
| 参照は、LabelSelector で選択された、Operator のコンポーネントリソースへの参照のセットです。 |
|
| RichReference は、ステータス条件が強化されたリソースへの参照です。 |
6.1.4. .status.components.labelSelector
- 説明
- LabelSelector は、Operator のコンポーネントを選択するために使用される一連のリソースに対するラベルクエリーです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
6.1.5. .status.components.labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
6.1.6. .status.components.labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
6.1.7. .status.components.refs
- 説明
- 参照は、LabelSelector で選択された、Operator のコンポーネントリソースへの参照のセットです。
- 型
-
array
6.1.8. .status.components.refs[]
- 説明
- RichReference は、ステータス条件が強化されたリソースへの参照です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| 条件は、コンポーネントの最新の状態を表します。 |
|
| 状態は、コンポーネントの状態の最新の利用可能な観測を表します。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
6.1.9. .status.components.refs[].conditions
- 説明
- 条件は、コンポーネントの最新の状態を表します。
- 型
-
array
6.1.10. .status.components.refs[].conditions[]
- 説明
- 状態は、コンポーネントの状態の最新の利用可能な観測を表します。
- 型
-
object
- 必須
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 最後にある状態から別の状態に遷移した時間。 |
|
| 前回条件が調査されたとき |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| 状態のタイプ。 |
6.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v1/operators
-
DELETE
:Operator のコレクションを削除します -
GET
: kind が Operator のオブジェクトをリスト表示します。 -
POST
:Operator を作成します
-
/apis/operators.coreos.com/v1/operators/{name}
-
DELETE
: Operator を削除します。 -
GET
: 指定された Operator を読み取ります -
PATCH
: 指定された Operator を部分的に更新します -
PUT
: 指定された Operator を置き換えます
-
/apis/operators.coreos.com/v1/operators/{name}/status
-
GET
: 指定された Operator のステータスを読み取ります -
PATCH
: 指定された Operator のステータスを部分的に更新します -
PUT
: 指定された Operator のステータスを置き換えます
-
6.2.1. /apis/operators.coreos.com/v1/operators
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- Operator のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示する Operator
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- Operator を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
6.2.2. /apis/operators.coreos.com/v1/operators/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| Operator の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- Operator を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された Operator を読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Operator を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された Operator を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
6.2.3. /apis/operators.coreos.com/v1/operators/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| Operator の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された Operator のステータスを読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Operator のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
fieldValidation は、 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された Operator のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
fieldValidation は、 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第7章 OperatorCondition [operators.coreos.com/v2]
- 説明
-
OperatorCondition は、
OperatorCondition
タイプのカスタムリソースであり、Operator の状態に関する情報を OLM に伝達するために使用されます。 - 型
-
object
- 必須
-
metadata
-
7.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| OperatorConditionSpec を使用すると、Operator は状態を OLM に報告でき、クラスター管理者は Operator によって報告された状態を手動でオーバーライドできます。 |
|
| OperatorConditionStatus を使用すると、OLM はどの条件が観察されたかを伝えることができます。 |
7.1.1. .spec
- 説明
- OperatorConditionSpec を使用すると、Operator は状態を OLM に報告でき、クラスター管理者は Operator によって報告された状態を手動でオーバーライドできます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded"//+ patchMergeKey = type//+ patchStrategy = merge//+ listType = map//+ listMapKey = type Conditions metav1.Condition |
|
| |
|
| |
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded"//+ patchMergeKey = type//+ patchStrategy = merge//+ listType = map//+ listMapKey = type Conditions metav1.Condition |
|
|
7.1.2. .spec.conditions
- 説明
- 型
-
array
7.1.3. .spec.conditions[]
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields } - 型
-
object
- 必須
-
lastTransitionTime
-
message
-
reason
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
7.1.4. .spec.overrides
- 説明
- 型
-
array
7.1.5. .spec.overrides[]
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields } - 型
-
object
- 必須
-
message
-
reason
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
7.1.6. .status
- 説明
- OperatorConditionStatus を使用すると、OLM はどの条件が観察されたかを伝えることができます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
7.1.7. .status.conditions
- 説明
- 型
-
array
7.1.8. .status.conditions[]
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields } - 型
-
object
- 必須
-
lastTransitionTime
-
message
-
reason
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
7.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v2/operatorconditions
-
GET
: kind が OperatorCondition のオブジェクトをリスト表示します。
-
/apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions
-
DELETE
:OperatorCondition のコレクションを削除します -
GET
: kind が OperatorCondition のオブジェクトをリスト表示します。 -
POST
:OperatorCondition を作成します
-
/apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}
-
DELETE
: OperatorCondition を削除します。 -
GET
: 指定された OperatorCondition を読み取ります -
PATCH
: 指定された OperatorCondition を部分的に更新します -
PUT
: 指定された OperatorCondition を置き換えます
-
/apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}/status
-
GET
: 指定された OperatorCondition のステータスを読み取ります -
PATCH
: 指定された OperatorCondition のステータスを部分的に更新します -
PUT
: 指定された OperatorCondition のステータスを置き換えます
-
7.2.1. /apis/operators.coreos.com/v2/operatorconditions
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が OperatorCondition のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
7.2.2. /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- OperatorCondition のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示する OperatorCondition
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- OperatorCondition を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.2.3. /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| OperatorCondition の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- OperatorCondition を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された OperatorCondition を読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された OperatorCondition を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された OperatorCondition を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.2.4. /apis/operators.coreos.com/v2/namespaces/{namespace}/operatorconditions/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| OperatorCondition の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された OperatorCondition のステータスを読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された OperatorCondition のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された OperatorCondition のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
fieldValidation は、 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第8章 OperatorGroup [operators.coreos.com/v1]
- 説明
- OperatorGroup は、OLM マネージドオペレーターのマルチテナンシーの単位です。名前空間への Operator のインストールを、指定されたターゲット名前空間のセットに制限します。
- 型
-
object
- 必須
-
metadata
-
8.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| OperatorGroupSpec は、OperatorGroup リソースの仕様です。 |
|
| OperatorGroupStatus は、OperatorGroupResource のステータスです。 |
8.1.1. .spec
- 説明
- OperatorGroupSpec は、OperatorGroup リソースの仕様です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Selector は、OperatorGroup のターゲット名前空間を選択します。 |
|
| ServiceAccountName は、この Operator グループにオペレーターをデプロイするために使用される管理者指定のサービスアカウントです。 |
|
| Static は、OperatorGroup の providedAPIs アノテーションを更新しないように OLM に指示します |
|
| TargetNamespaces は、ターゲットとする名前空間の明示的なセットです。設定されている場合、セレクターは無視されます。 |
|
| UpgradeStrategy は、namespace 内の Operator のアップグレードストラテジーを定義します。現時点でサポートされるアップグレードストラテジーの 2 つがあります。デフォルト:OLM は、clusterServiceVersion が成功したフェーズから置き換えフェーズに移動できるようにします。つまり、インストールまたはアップグレードが失敗した場合、Operator が次のバージョンに移行することが OLM によって許可されません。TechPreviewUnsafeFailForward: clusterServiceVersions が成功フェーズまたは失敗フェーズから置換フェーズに移行することが OLM によって許可されます。また、サブスクリプションが失敗した installPlan を参照しており、既存の Operator セットの新しいアップグレードでカタログが更新された場合に、OLM が新しい installPlan を生成します。警告: TechPreviewUnsafeFailForward アップグレードストラテジーは安全ではありません。namespace で管理されている Operator セットについて深く理解していないと、予期しない動作や回復不可能なデータ損失が発生する可能性があります。 |
8.1.2. .spec.selector
- 説明
- Selector は、OperatorGroup のターゲット名前空間を選択します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
8.1.3. .spec.selector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
8.1.4. .spec.selector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
8.1.5. .status
- 説明
- OperatorGroupStatus は、OperatorGroupResource のステータスです。
- 型
-
object
- 必須
-
lastUpdated
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 条件は、OperatorGroup の条件の配列です。 |
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
|
| LastUpdated は、OperatorGroup のステータスが最後に更新されたときのタイムスタンプです。 |
|
| 名前空間は、OperatorGroup のターゲット名前空間のセットです。 |
|
| ServiceAccountRef は、指定されたサービスアカウントオブジェクトを参照します。 |
8.1.6. .status.conditions
- 説明
- 条件は、OperatorGroup の条件の配列です。
- 型
-
array
8.1.7. .status.conditions[]
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"
// other fields } - 型
-
object
- 必須
-
lastTransitionTime
-
message
-
reason
-
status
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
8.1.8. .status.serviceAccountRef
- 説明
- ServiceAccountRef は、指定されたサービスアカウントオブジェクトを参照します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
8.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/operators.coreos.com/v1/operatorgroups
-
GET
: kind が OperatorGroup のオブジェクトをリスト表示します。
-
/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups
-
DELETE
:OperatorGroup のコレクションを削除します -
GET
: kind が OperatorGroup のオブジェクトをリスト表示します。 -
POST
:OperatorGroup を作成します
-
/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}
-
DELETE
: OperatorGroup を削除します。 -
GET
: 指定された OperatorGroup を読み取ります -
PATCH
: 指定された OperatorGroup を部分的に更新します -
PUT
: 指定された OperatorGroup を置き換えます
-
/apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}/status
-
GET
: 指定された OperatorGroup のステータスを読み取ります -
PATCH
: 指定された OperatorGroup のステータスを部分的に更新します -
PUT
: 指定された OperatorGroup のステータスを置き換えます
-
8.2.1. /apis/operators.coreos.com/v1/operatorgroups
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が OperatorGroup のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
8.2.2. /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- OperatorGroup のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類 OperatorGroup のオブジェクトをリスト表示します
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- OperatorGroup の作成
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
fieldValidation は、 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
8.2.3. /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| OperatorGroup の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- OperatorGroup を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 指定された OperatorGroup を読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された OperatorGroup を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された OperatorGroup を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
8.2.4. /apis/operators.coreos.com/v1/namespaces/{namespace}/operatorgroups/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| OperatorGroup の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された OperatorGroup のステータスを読み取ります
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された OperatorGroup のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された OperatorGroup のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第9章 PackageManifest [packages.operators.coreos.com/v1]
- 説明
- PackageManifest は、パッケージに関する情報を保持します。これは、単一のパッケージの下にある 1 つ (または複数) のチャネルへの参照です。
- 型
-
object
9.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| ||
|
| PackageManifestSpec は、PackageManifest の望ましい状態を定義します |
|
| PackageManifestStatus は、PackageManifest の現在のステータスを表します |
9.1.1. .spec
- 説明
- PackageManifestSpec は、PackageManifest の望ましい状態を定義します
- 型
-
object
9.1.2. .status
- 説明
- PackageManifestStatus は、PackageManifest の現在のステータスを表します
- 型
-
object
- 必須
-
catalogSource
-
catalogSourceDisplayName
-
catalogSourcePublisher
-
catalogSourceNamespace
-
packageName
-
channels
-
defaultChannel
-
プロパティー | 型 | 説明 |
---|---|---|
|
| CatalogSource は、このパッケージが属する CatalogSource の名前です。 |
|
| |
|
| CatalogSourceNamespace は、所有する CatalogSource の名前空間です。 |
|
| |
|
|
チャネルは、パッケージの宣言されたチャネルであり、 |
|
| PackageChannel は、パッケージの下に単一のチャネルを定義し、そのパッケージのバージョンを指します。 |
|
| DefaultChannel は、指定されている場合、パッケージのデフォルトチャネルの名前です。他のチャネルが明示的に指定されていない場合、デフォルトのチャネルがインストールされます。パッケージに単一のチャネルがある場合、そのチャネルは暗黙的にデフォルトになります。 |
|
|
PackageName は、パッケージ全体の名前、ala |
|
| AppLink は、アプリケーションへのリンクを定義します |
9.1.3. .status.channels
- 説明
-
チャネルは、パッケージの宣言されたチャネルであり、
安定版
またはアルファ版
です。 - 型
-
array
9.1.4. .status.channels[]
- 説明
- PackageChannel は、パッケージの下に単一のチャネルを定義し、そのパッケージのバージョンを指します。
- 型
-
object
- 必須
-
name
-
currentCSV
-
プロパティー | 型 | 説明 |
---|---|---|
|
| CurrentCSV は、現在チャネル用にこのパッケージのバージョンを保持している CSV への参照を定義します。 |
|
| CSVDescription は、CSV の説明を定義します |
|
|
名前はチャネルの名前です (例: |
9.1.5. .status.channels[].currentCSVDesc
- 説明
- CSVDescription は、CSV の説明を定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
| ||
| ||
|
| LongDescription は CSV の説明です |
|
| DisplayName は、CSV の表示名です。 |
|
| アイコンは CSV の base64 エンコードアイコンです |
|
| アイコンは、base64 でエンコードされたアイコンとメディアタイプを定義します |
| InstallModes は、サポートされているインストールタイプを指定します | |
|
| |
|
| |
|
| AppLink は、アプリケーションへのリンクを定義します |
|
| |
|
| メンテナーはプロジェクトメンテナーを定義します |
|
| |
|
| Operator がインストールするための Kubernetes の最小バージョン |
| ||
|
| AppLink は、アプリケーションへのリンクを定義します |
|
| 関連イメージのリスト |
| バージョンは CSV のセマンティックバージョンです |
9.1.6. .status.channels[].currentCSVDesc.icon
- 説明
- アイコンは CSV の base64 エンコードアイコンです
- 型
-
array
9.1.7. .status.channels[].currentCSVDesc.icon[]
- 説明
- アイコンは、base64 でエンコードされたアイコンとメディアタイプを定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
9.1.8. .status.channels[].currentCSVDesc.links
- 説明
- 型
-
array
9.1.9. .status.channels[].currentCSVDesc.links[]
- 説明
- AppLink は、アプリケーションへのリンクを定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
9.1.10. .status.channels[].currentCSVDesc.maintainers
- 説明
- 型
-
array
9.1.11. .status.channels[].currentCSVDesc.maintainers[]
- 説明
- メンテナーはプロジェクトメンテナーを定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
9.1.12. .status.channels[].currentCSVDesc.provider
- 説明
- AppLink は、アプリケーションへのリンクを定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
9.1.13. .status.provider
- 説明
- AppLink は、アプリケーションへのリンクを定義します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
|
9.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/packages.operators.coreos.com/v1/packagemanifests
-
GET
: kind が PackageManifest のオブジェクトをリスト表示します。
-
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests
-
GET
: kind が PackageManifest のオブジェクトをリスト表示します。
-
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}
-
GET
: 指定された PackageManifest を読み取ります
-
/apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon
-
GET
:GET リクエストを PackageManifest のアイコンに接続します
-
9.2.1. /apis/packages.operators.coreos.com/v1/packagemanifests
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が PackageManifest のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
9.2.2. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- kind が PackageManifest のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
9.2.3. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| PackageManifest の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された PackageManifest を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
9.2.4. /apis/packages.operators.coreos.com/v1/namespaces/{namespace}/packagemanifests/{name}/icon
パラメーター | 型 | 説明 |
---|---|---|
|
| PackageManifest の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
- HTTP メソッド
-
GET
- 説明
- GET リクエストを PackageManifest のアイコンに接続します
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
第10章 Subscription [operators.coreos.com/v1alpha1]
- 説明
- サブスクリプションは、カタログへの変更を追跡することにより、Operator を最新の状態に保ちます。
- 型
-
object
- 必須
-
metadata
-
spec
-
10.1. 仕様
プロパティー | 型 | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| SubscriptionSpec は、インストール可能なアプリケーションを定義します |
|
|
10.1.1. .spec
- 説明
- SubscriptionSpec は、インストール可能なアプリケーションを定義します
- 型
-
object
- 必須
-
name
-
source
-
sourceNamespace
-
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| SubscriptionConfig には、サブスクリプションに指定された設定が含まれています。 |
|
| 承認は、InstallPlan のユーザー認可ポリシーです。"Automatic" または "Manual" のいずれかである必要があります。 |
|
| |
|
| |
|
| |
|
|
10.1.2. .spec.config
- 説明
- SubscriptionConfig には、サブスクリプションに指定された設定が含まれています。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 指定されている場合、Pod のスケジュール制約がオーバーライドされます。nil サブ属性は、pod.spec 内にある nil サブ属性の元の値を オーバーライドしません。元のサブ属性値を消去するには、空のオブジェクト ({}) を使用します。 |
|
| Env は、コンテナーに設定する環境変数のリストです。これを更新することはできません。 |
|
| EnvVar は、コンテナーに存在する環境変数を表します。 |
|
| EnvFrom は、コンテナー内の環境変数に入力するソースのリストです。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。Immutable. |
|
| EnvFromSource は、一連の ConfigMap のソースを表します |
|
| NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。詳細: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
|
| リソースは、このコンテナーに必要なコンピューティングリソースを表します。Immutable.詳細: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
|
| セレクターは、設定する Pod のラベルセレクターです。これによって Pod が選択される既存の ReplicaSet は、このデプロイメントの影響を受けるものになります。Pod テンプレートのラベルと一致する必要があります。 |
|
| 許容値は Pod の許容値です。 |
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
|
| コンテナーに設定する VolumeMounts のリスト。 |
|
| VolumeMount は、コンテナー内でのボリュームのマウントを説明します。 |
|
| podSpec で設定するボリュームのリスト。 |
|
| ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。 |
10.1.3. .spec.config.affinity
- 説明
- 指定されている場合、Pod のスケジュール制約がオーバーライドされます。nil サブ属性は、pod.spec 内にある nil サブ属性の元の値を オーバーライドしません。元のサブ属性値を消去するには、空のオブジェクト ({}) を使用します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Pod のノードアフィニティースケジューリングルールを説明します。 |
|
| Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。 |
|
| Pod の非アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。 |
10.1.4. .spec.config.affinity.nodeAffinity
- 説明
- Pod のノードアフィニティースケジューリングルールを説明します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
| 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。 |
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。 |
10.1.5. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 説明
- スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
- 型
-
array
10.1.6. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 説明
- 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
- 型
-
object
- 必須
-
preference
-
weight
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 対応する重みに関連付けられたノードセレクター用語。 |
|
| 対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。 |
10.1.7. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
- 説明
- 対応する重みに関連付けられたノードセレクター用語。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
10.1.8. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
10.1.9. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.10. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
10.1.11. .spec.config.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.12. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 説明
- このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。
- 型
-
object
- 必須
-
nodeSelectorTerms
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。ノードセレクター用語のリスト。用語は OR されています。 |
|
| null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。 |
10.1.13. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
- 説明
- 必須。ノードセレクター用語のリスト。用語は OR されています。
- 型
-
array
10.1.14. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
- 説明
- null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
10.1.15. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
10.1.16. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.17. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
10.1.18. .spec.config.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.19. .spec.config.affinity.podAffinity
- 説明
- Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
| この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。 |
10.1.20. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 説明
- スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
- 型
-
array
10.1.21. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 説明
- 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
- 型
-
object
- 必須
-
podAffinityTerm
-
weight
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
10.1.22. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
10.1.23. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.24. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.25. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.26. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.27. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.28. .spec.config.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.29. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 説明
- このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
- 型
-
array
10.1.30. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 説明
- この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
10.1.31. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.32. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.33. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.34. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.35. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.36. .spec.config.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.37. .spec.config.affinity.podAntiAffinity
- 説明
- Pod の非アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
| このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
| この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。 |
10.1.38. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
- 説明
- スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。
- 型
-
array
10.1.39. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
- 説明
- 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
- 型
-
object
- 必須
-
podAffinityTerm
-
weight
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
10.1.40. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
10.1.41. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.42. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.43. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.44. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.45. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.46. .spec.config.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.47. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
- 説明
- このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。
- 型
-
array
10.1.48. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
- 説明
- この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
- 型
-
object
- 必須
-
topologyKey
-
プロパティー | 型 | 説明 |
---|---|---|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 |
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
10.1.49. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。
- タイプ
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.50. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.51. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.52. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.53. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.54. .spec.config.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.55. .spec.config.env
- 説明
- Env は、コンテナーに設定する環境変数のリストです。これを更新することはできません。
- 型
-
array
10.1.56. .spec.config.env[]
- 説明
- EnvVar は、コンテナーに存在する環境変数を表します。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 環境変数の名前。C_IDENTIFIER でなければなりません。 |
|
| 変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。 |
|
| 環境変数の値のソースです。値が空でない場合は使用できません。 |
10.1.57. .spec.config.env[].valueFrom
- 説明
- 環境変数の値のソースです。値が空でない場合は使用できません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ConfigMap のキーを選択します。 |
|
|
Pod のフィールドを選択します。metadata.name、metadata.namespace、 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。 |
|
| Pod の namespace でシークレットのキーを選択します |
10.1.58. .spec.config.env[].valueFrom.configMapKeyRef
- 説明
- ConfigMap のキーを選択します。
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
10.1.59. .spec.config.env[].valueFrom.fieldRef
- 説明
-
Pod のフィールドを選択します。metadata.name、metadata.namespace、
metadata.labels['<KEY>']
、metadata.annotations['<KEY>']
、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs がサポートされています。 - 型
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
10.1.60. .spec.config.env[].valueFrom.resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
10.1.61. .spec.config.env[].valueFrom.secretKeyRef
- 説明
- Pod の namespace でシークレットのキーを選択します
- 型
-
object
- 必須
-
key
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
10.1.62. .spec.config.envFrom
- 説明
- EnvFrom は、コンテナー内の環境変数に入力するソースのリストです。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。Immutable.
- 型
-
array
10.1.63. .spec.config.envFrom[]
- 説明
- EnvFromSource は、一連の ConfigMap のソースを表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 選択する ConfigMap |
|
| ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。 |
|
| から選択する秘密 |
10.1.64. .spec.config.envFrom[].configMapRef
- 説明
- 選択する ConfigMap
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| ConfigMap を定義する必要があるかどうかを指定します |
10.1.65. .spec.config.envFrom[].secretRef
- 説明
- から選択する秘密
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| シークレットを定義する必要があるかどうかを指定します |
10.1.66. .spec.config.resources
- 説明
- リソースは、このコンテナーに必要なコンピューティングリソースを表します。Immutable.詳細: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
10.1.67. .spec.config.selector
- 説明
- セレクターは、設定する Pod のラベルセレクターです。これによって Pod が選択される既存の ReplicaSet は、このデプロイメントの影響を受けるものになります。Pod テンプレートのラベルと一致する必要があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.68. .spec.config.selector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.69. .spec.config.selector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.70. .spec.config.tolerations
- 説明
- 許容値は Pod の許容値です。
- 型
-
array
10.1.71. .spec.config.tolerations[]
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。 |
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
10.1.72. .spec.config.volumeMounts
- 説明
- コンテナーに設定する VolumeMounts のリスト。
- 型
-
array
10.1.73. .spec.config.volumeMounts[]
- 説明
- VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
- 型
-
object
- 必須
-
mountPath
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。 |
|
| mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。 |
|
| ボリュームの名前に一致する必要があります。 |
|
| true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。 |
10.1.74. .spec.config.volumes
- 説明
- podSpec で設定するボリュームのリスト。
- 型
-
array
10.1.75. .spec.config.volumes[]
- 説明
- ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
- 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。 |
|
| azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。 |
|
| cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。 |
|
| Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| configMap は、このボリュームに入力する必要がある configMap を表します |
|
| csi (Container Storage Interface) は、特定の外部 CSI ドライバー (ベータ機能) によって処理される一時的なストレージを表します。 |
|
| downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します |
|
| emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
| ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。 |
|
| fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。 |
|
| flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。 |
|
| flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります |
|
| gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。 |
|
| glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md |
|
| hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。 |
|
| iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md |
|
| ボリュームの名前。DNS_LABEL であり、Pod 内で一意である必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
| photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。 |
|
| portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。 |
|
| オールインワンリソースシークレット、configmaps、および Downward API のアイテム |
|
| quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します |
|
| rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md |
|
| scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。 |
|
| secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
| storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。 |
|
| vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。 |
10.1.76. .spec.config.volumes[].awsElasticBlockStore
- 説明
- awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。 |
|
| readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
10.1.77. .spec.config.volumes[].azureDisk
- 説明
- azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
- 型
-
object
- 必須
-
diskName
-
diskURI
-
プロパティー | 型 | 説明 |
---|---|---|
|
| cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。 |
|
| diskName は、Blob ストレージ内のデータディスクの名前です。 |
|
| diskURI は、BLOB ストレージ内のデータディスクの URI です |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。 |
|
| readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
10.1.78. .spec.config.volumes[].azureFile
- 説明
- azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
- 型
-
object
- 必須
-
secretName
-
shareName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。 |
|
| shareName は Azure 共有名です。 |
10.1.79. .spec.config.volumes[].cephfs
- 説明
- cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。
- 型
-
object
- 必須
-
monitors
-
プロパティー | 型 | 説明 |
---|---|---|
|
| monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| user 任意: User は rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
10.1.80. .spec.config.volumes[].cephfs.secretRef
- 説明
- secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
10.1.81. .spec.config.volumes[].cinder
- 説明
- Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。 |
|
| cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
10.1.82. .spec.config.volumes[].cinder.secretRef
- 説明
- secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
10.1.83. .spec.config.volumes[].configMap
- 説明
- configMap は、このボリュームに入力する必要がある configMap を表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| 任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
10.1.84. .spec.config.volumes[].configMap.items
- 説明
- item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
10.1.85. .spec.config.volumes[].configMap.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
10.1.86. .spec.config.volumes[].csi
- 説明
- csi (Container Storage Interface) は、特定の外部 CSI ドライバー (ベータ機能) によって処理される一時的なストレージを表します。
- 型
-
object
- 必須
-
driver
-
プロパティー | 型 | 説明 |
---|---|---|
|
| driver は、このボリュームを処理する CSI ドライバーの名前です。クラスターに登録されている正しい名前は、管理者に相談してください。 |
|
| マウントする fsType。例: "ext4"、"xfs"、"ntfs"。指定しない場合、空の値が関連する CSI ドライバーに渡され、適用するデフォルトのファイルシステムが決定されます。 |
|
| nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。 |
|
| readOnly は、ボリュームの読み取り専用設定を指定します。デフォルトは false (読み取り/書き込み) です。 |
|
| volumeAttributes は、CSI ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。 |
10.1.87. .spec.config.volumes[].csi.nodePublishSecretRef
- 説明
- nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
10.1.88. .spec.config.volumes[].downwardAPI
- 説明
- downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| オプション: デフォルトで作成されたファイルで使用するモードビット。オプション: デフォルトで作成されたファイルのパーミッションを設定するために使用されるモードビット。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| items は、Downward API ボリュームファイルのリストです |
|
| DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します |
10.1.89. .spec.config.volumes[].downwardAPI.items
- 説明
- items は、Downward API ボリュームファイルのリストです
- 型
-
array
10.1.90. .spec.config.volumes[].downwardAPI.items[]
- 説明
- DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。 |
|
| オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| 必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。 |
10.1.91. .spec.config.volumes[].downwardAPI.items[].fieldRef
- Description
- 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
- タイプ
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
10.1.92. .spec.config.volumes[].downwardAPI.items[].resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
10.1.93. .spec.config.volumes[].emptyDir
- 説明
- emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| medium は、このディレクトリーをバックアップする必要があるストレージメディアのタイプを表します。デフォルトは"" です。これは、ノードのデフォルトのメディアを使用することを意味します。空の文字列 (デフォルト) またはメモリーである必要があります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
|
| sizeLimit は、この EmptyDir ボリュームに必要なローカルストレージの合計量です。サイズ制限はメモリーメディアにも適用されます。メモリーメディア EmptyDir での最大使用量は、ここで指定された SizeLimit と Pod 内のすべてのコンテナーのメモリー制限の合計との間の最小値になります。デフォルトは nil です。これは、制限が未定義であることを意味します。詳細: http://kubernetes.io/docs/user-guide/volumes#emptydir |
10.1.94. .spec.config.volumes[].ephemeral
- 説明
- ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は |
10.1.95. .spec.config.volumes[].ephemeral.volumeClaimTemplate
- 説明
-
ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は
<pod name>-<volume name>
になります。ここで、<volume name>
はPodSpec.Volumes
アレイエントリーからの名前です。連結された名前が PVC に対して有効でない場合 (たとえば、長すぎる場合)、Pod 検証は Pod を拒否します。Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。必須です。nil であってはなりません。 - 型
-
object
- 必須
-
spec
-
プロパティー | 型 | 説明 |
---|---|---|
|
| PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。 |
|
| PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。 |
10.1.96. .spec.config.volumes[].ephemeral.volumeClaimTemplate.metadata
- 説明
- PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。
- 型
-
object
10.1.97. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec
- 説明
- PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
|
| dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。 |
|
| dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
|
| resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
|
| selector は、バインドを考慮するボリュームに対するラベルクエリーです。 |
|
| storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
| volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。 |
|
| volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。 |
10.1.98. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource
- 説明
- dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource 機能ゲートが有効になっている場合、このフィールドは常に DataSourceRef フィールドと同じ内容になります。
- タイプ
-
object
- 必須
-
kind
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
10.1.99. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef
- 説明
- dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これは、空でない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のローカルオブジェクトである可能性があります。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、DataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性のために、両方のフィールド (DataSource と DataSourceRef) は、一方が空でもう一方が空でない場合、自動的に同じ値に設定されます。DataSource と DataSourceRef には 2 つの重要な違いがあります。*DataSource は 2 つの特定のタイプのオブジェクトのみを許可しますが、DataSourceRef は非コアオブジェクトと PersistentVolumeClaim オブジェクトを許可します。* DataSource は許可されていない値を無視 (ドロップ) しますが、DataSourceRef はすべての値を保持し、許可されていない値が指定されている場合はエラーを生成します。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
10.1.100. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.resources
- 説明
- resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
10.1.101. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector
- 説明
- selector は、バインドを考慮するボリュームに対するラベルクエリーです。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
10.1.102. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
10.1.103. .spec.config.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
10.1.104. .spec.config.volumes[].fc
- 説明
- fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。TODO: ファイルシステムのエラーがマシンを危険にさらすのを防ぐにはどうすればよいですか ? |
|
| LUN は任意: FC ターゲットの LUN 番号 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN) |
|
| wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。 |
10.1.105. .spec.config.volumes[].flexVolume
- 説明
- flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。
- 型
-
object
- 必須
-
driver
-
プロパティー | 型 | 説明 |
---|---|---|
|
| driver は、このボリュームに使用するドライバーの名前です。 |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。 |
|
| options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。 |
10.1.106. .spec.config.volumes[].flexVolume.secretRef
- 説明
- secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
10.1.107. .spec.config.volumes[].flocker
- 説明
- flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。 |
|
| datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です |
10.1.108. .spec.config.volumes[].gcePersistentDisk
- 説明
- gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
- 型
-
object
- 必須
-
pdName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
10.1.109. .spec.config.volumes[].gitRepo
- 説明
- gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。
- 型
-
object
- 必須
-
repository
-
プロパティー | 型 | 説明 |
---|---|---|
|
| directory は、ターゲットディレクトリー名です。'..' を含まない、または..で始まらないようにする必要があります。もしも '。' が提供されている場合、ボリュームディレクトリーは git リポジトリーになります。それ以外の場合、指定されている場合、ボリュームには、指定された名前のサブディレクトリーに git リポジトリーが含まれます。 |
|
| repository は URL です。 |
|
| revision は、指定されたリビジョンのコミットハッシュです。 |
10.1.110. .spec.config.volumes[].glusterfs
- 説明
- glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md
- 型
-
object
- 必須
-
endpoints
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
10.1.111. .spec.config.volumes[].hostPath
- 説明
- hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) ホストディレクトリーのマウントを使用できる人、およびホストディレクトリーを読み取り/書き込みでマウントできる人/できない人を制限する必要があります。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
10.1.112. .spec.config.volumes[].iscsi
- 説明
- iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md
- 型
-
object
- 必須
-
iqn
-
lun
-
targetPortal
-
プロパティー | 型 | 説明 |
---|---|---|
|
| chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。 |
|
| chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。 |
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: ファイルシステムのエラーによるマシンの侵害を防ぐにはどうすればよいですか ? |
|
| initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。 |
|
| iqn は、ターゲットの iSCSI 修飾名です。 |
|
| iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。 |
|
| lun は、iSCSI ターゲット Lun 番号を表します。 |
|
| ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。 |
|
| secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。 |
|
| targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
10.1.113. .spec.config.volumes[].iscsi.secretRef
- 説明
- secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
10.1.114. .spec.config.volumes[].nfs
- 説明
- NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs
- 型
-
object
- 必須
-
path
-
server
-
プロパティー | 型 | 説明 |
---|---|---|
|
| NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
10.1.115. .spec.config.volumes[].persistentVolumeClaim
- 説明
- persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
- 型
-
object
- 必須
-
claimName
-
プロパティー | 型 | 説明 |
---|---|---|
|
| claimName は、このボリュームを使用する Pod と同じ namespace にある PersistentVolumeClaim の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
| readOnly は、VolumeMounts の ReadOnly 設定が強制的に指定されます。デフォルト: false |
10.1.116. .spec.config.volumes[].photonPersistentDisk
- 説明
- photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。
- 型
-
object
- 必須
-
pdID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| pdID は、Photon Controller の永続ディスクを識別する ID です。 |
10.1.117. .spec.config.volumes[].portworxVolume
- 説明
- portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。
- 型
-
object
- 必須
-
volumeID
-
プロパティー | 型 | 説明 |
---|---|---|
|
| fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| volumeID は、Portworx ボリュームを一意に識別します |
10.1.118. .spec.config.volumes[].projected
- 説明
- オールインワンリソースシークレット、configmaps、および Downward API のアイテム
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| defaultMode は、作成されたファイルにデフォルトでアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| source は、ボリュームプロジェクションのリストです。 |
|
| サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション |
10.1.119. .spec.config.volumes[].projected.sources
- 説明
- source は、ボリュームプロジェクションのリストです。
- 型
-
array
10.1.120. .spec.config.volumes[].projected.sources[]
- 説明
- サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| プロジェクトへの configMap データの onfigMap 情報 |
|
| downwardAPI データのプロジェクトへの downwardAPI 情報 |
|
| 投影するシークレットデータに関する情報 |
|
| serviceAccountToken は、投影する serviceAccountToken データに関する情報です。 |
10.1.121. .spec.config.volumes[].projected.sources[].configMap
- 説明
- プロジェクトへの configMap データの onfigMap 情報
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| 任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
10.1.122. .spec.config.volumes[].projected.sources[].configMap.items
- 説明
- item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
10.1.123. .spec.config.volumes[].projected.sources[].configMap.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
10.1.124. .spec.config.volumes[].projected.sources[].downwardAPI
- 説明
- downwardAPI データのプロジェクトへの downwardAPI 情報
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Items は DownwardAPIVolume ファイルのリストです |
|
| DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します |
10.1.125. .spec.config.volumes[].projected.sources[].downwardAPI.items
- 説明
- Items は DownwardAPIVolume ファイルのリストです
- 型
-
array
10.1.126. .spec.config.volumes[].projected.sources[].downwardAPI.items[]
- 説明
- DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。 |
|
| オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| 必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。 |
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。 |
10.1.127. .spec.config.volumes[].projected.sources[].downwardAPI.items[].fieldRef
- Description
- 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、名前空間のみがサポートされます。
- タイプ
-
object
- 必須
-
fieldPath
-
プロパティー | 型 | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
10.1.128. .spec.config.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。
- 型
-
object
- 必須
-
resource
-
プロパティー | 型 | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
| 必須: 選択するリソース |
10.1.129. .spec.config.volumes[].projected.sources[].secret
- 説明
- 投影するシークレットデータに関する情報
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 |
|
| 文字列キーをボリューム内のパスにマップします。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
| オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。 |
10.1.130. .spec.config.volumes[].projected.sources[].secret.items
- 説明
- items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。
- 型
-
array
10.1.131. .spec.config.volumes[].projected.sources[].secret.items[]
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
10.1.132. .spec.config.volumes[].projected.sources[].serviceAccountToken
- 説明
- serviceAccountToken は、投影する serviceAccountToken データに関する情報です。
- 型
-
object
- 必須
-
path
-
プロパティー | 型 | 説明 |
---|---|---|
|
| audience は、トークンの対象オーディエンスです。トークンの受信者は、トークンのオーディエンスで指定された識別子で自分自身を識別する必要があります。そうでない場合は、トークンを拒否する必要があります。対象はデフォルトで API サーバーの識別子に設定されます。 |
|
| expirationSeconds は、サービスアカウントトークンの要求された有効期間です。トークンの有効期限が近づくと、kubelet ボリュームプラグインはサービスアカウントトークンをプロアクティブにローテーションします。トークンが存続時間の 80% より古い場合、またはトークンが 24 時間より古い場合、kubelet はトークンのローテーションを開始します。デフォルトは 1 時間で、少なくとも 10 分である必要があ |