Operator API


OpenShift Container Platform 4.12

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

Red Hat OpenShift Documentation Team

概要

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

第1章 Operator API

1.1. Authentication [operator.openshift.io/v1]

説明
認証は、認証を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.2. CloudCredential [operator.openshift.io/v1]

説明
CloudCredential は、CredentialsRequests を管理するように Operator を設定する手段を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.3. ClusterCSIDriver [operator.openshift.io/v1]

説明
ClusterCSIDriver オブジェクトを使用すると、OpenShift にデフォルトでインストールされている CSI ドライバー Operator の管理と設定が可能になります。オブジェクトの名前は、それが動作する CSI ドライバーの名前である必要があります。許可される値のリストは、CSIDriverName タイプを参照してください。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.4. Console [operator.openshift.io/v1]

説明
コンソールは、コンソールを管理するように Operator を設定する手段を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.5. Config [operator.openshift.io/v1]

説明
Config は、クラスター上に他のコンポーネントの初期設定を作成する役割を担う config Operator の動作を指定します。この Operator は、AWS および Azure クラウドをベースとしたクラスターのクラウド設定のインストール、移行、または同期も処理します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object

1.6. Config [imageregistry.operator.openshift.io/v1]

説明
Config は、レジストリー Operator によって管理されるレジストリーインスタンスの設定オブジェクトです。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object

1.7. Config [samples.operator.openshift.io/v1]

説明
Config には、SamplesOperator の設定と詳細な条件ステータスが含まれています。
タイプ
object

1.8. CSISnapshotController [operator.openshift.io/v1]

説明
CSISnapshotController は、CSI スナップショットを管理するように Operator を設定する手段を提供します。cluster は正規名です。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.9. DNS [operator.openshift.io/v1]

説明
DNS は CoreDNS コンポーネントを管理し、クラスター内の Pod およびサービスの名前解決サービスを提供します。これは、DNS ベースのサービス検出仕様 (https://github.com/kubernetes/dns/blob/master/docs/specification.md) をサポートしています。詳細: https://kubernetes.io/docs/tasks/administer-cluster/coredns 互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object

1.10. DNSRecord [ingress.operator.openshift.io/v1]

説明
DNSRecord は、dns.config.openshift.io/cluster.spec.publicZone および.spec.privateZone によって定義されたゾーンで管理される DNS レコードです。このリソースのクラスター管理操作はサポートされていません。このリソースは、OpenShift Operator の内部通信専用です。DNSManagementPolicy が "Unmanaged" の場合、Operator はクラウドプロバイダー上の DNS レコードの管理を担当しません。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.11. Etcd [operator.openshift.io/v1]

説明
Etcd は、etcd を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.12. ImageContentSourcePolicy [operator.openshift.io/v1alpha1]

説明
ImageContentSourcePolicy は、レジストリーミラールールの処理方法に関するクラスター全体の情報を保持します。複数のポリシーが定義されている場合、動作の結果は各フィールドで定義されます。互換性レベル 4: 互換性は提供されていません。API は、理由を問わずいつでも変更できます。これらの機能は、長期サポートを必要とするアプリケーションで使用することはできません。
object

1.13. ImagePruner [imageregistry.operator.openshift.io/v1]

説明
ImagePruner は、レジストリー Operator によって管理されるイメージレジストリープルーナーの設定オブジェクトです。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.14. IngressController [operator.openshift.io/v1]

説明
IngressController は、クラスターの管理対象の Ingress コントローラーを表します。コントローラーは、OpenShift Route および Kubernetes Ingress リソースにサービスを提供できます。IngressController が作成されると、新しい Ingress コントローラーデプロイメントが作成され、Ingress または Route リソースを公開するサービスに外部トラフィックが到達できるようになります。このリソースを更新すると、新しい ingres コントローラーのリビジョンが公開される可能性があるため、一般向けのネットワーク接続が中断される可能性があります。https://kubernetes.io/docs/concepts/services-networking/ingress-controllers 可能な限り、プラットフォームの適切なデフォルトが使用されます。詳細は、各フィールドを参照してください。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.15. InsightsOperator [operator.openshift.io/v1]

説明
InsightsOperator は、Insights Operator に関するクラスター全体の情報を保持します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.16. KubeAPIServer [operator.openshift.io/v1]

説明
KubeAPIServer は、kube-apiserver を管理するための Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.17. KubeControllerManager [operator.openshift.io/v1]

説明
KubeControllerManager は、kube-controller-manager を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.18. KubeScheduler [operator.openshift.io/v1]

説明
KubeScheduler は、スケジューラーを管理する Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.19. KubeStorageVersionMigrator [operator.openshift.io/v1]

説明
KubeStorageVersionMigrator は、kube-storage-version-migrator を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.20. Network [operator.openshift.io/v1]

説明
ネットワークは、クラスターの目的のネットワーク設定を表します。これは、cluster-network-operator によって消費されます。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.21. OpenShiftAPIServer [operator.openshift.io/v1]

説明
OpenShiftAPIServer は、openshift-apiserver を管理するための Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.22. OpenShiftControllerManager [operator.openshift.io/v1]

説明
OpenShiftControllerManager は、openshift-controller-manager を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

1.23. OperatorPKI [network.operator.openshift.io/v1]

説明
OperatorPKI は、単純な認証局です。これは外部での使用を目的としたものではなく、ネットワーク Operator の内部で使用されます。CNO は、CA とその CA によって署名された証明書を作成します。証明書では、ClientAuth と ServerAuth の両方の拡張使用が有効になっています。より具体的には、<name> を持つ OperatorPKI が与えられると、CNO は以下を管理します。<name>- 単一のデータキーを持つ ca:-cabundle.crt-CA 証明書 -<name> と呼ばれるシークレット -2 つのデータキーを持つ証明書:-tls.key- 秘密キー --tls.crt- CA によって署名された証明書 CA 証明書の有効期間は 10 年で、9 日後にローテーションされます。ターゲット証明書の有効期間は 6 か月で、3 日後にローテーションされます。CA 証明書の CommonName は <namespace> _ <name> -ca @ <timestamp> になります。ここで、<timestamp> は最後のローテーション時間です。
タイプ
object

1.24. ServiceCA [operator.openshift.io/v1]

説明
ServiceCA は、サービス証明書コントローラーを管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (いずれか長い方) の間安定しています。
object

1.25. Storage [operator.openshift.io/v1]

説明
ストレージは、クラスターストレージ Operator を管理するように Operator を設定する手段を提供します。cluster は正規名です。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

第2章 Authentication [operator.openshift.io/v1]

説明
認証は、認証を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

2.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

 

status

object

 

2.1.1. .spec

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

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

2.1.2. .status

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

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、特定のリソースの生成を追跡するため、強制更新に関する決定を行うことができます。

oauthAPIServer

object

OAuthAPIServer は、oauth-apiserver にのみ固有のステータスを保持します

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

2.1.3. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

2.1.4. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

2.1.5. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

2.1.6. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

2.1.7. .status.oauthAPIServer

説明
OAuthAPIServer は、oauth-apiserver にのみ固有のステータスを保持します
object
Expand
プロパティータイプ説明

latestAvailableRevision

integer

LatestAvailableRevision は、encryption-config などの改訂されたシークレットの接尾辞として使用される最新の改訂です。新しいリビジョンにより、Pod が新たにデプロイされます。

2.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/authentications

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

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

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

2.2.1. /apis/operator.openshift.io/v1/authentications

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
認証のコレクションを削除する
Expand
表2.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表2.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
認証の種類のオブジェクトをリスト表示します
Expand
表2.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表2.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

AuthenticationList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
認証の作成
Expand
表2.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.7 ボディーパラメーター
パラメーター説明

body

Authentication スキーマ

 
Expand
表2.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

201 - Created

Authentication スキーマ

202 - Accepted

Authentication スキーマ

401 - Unauthorized

空白

2.2.2. /apis/operator.openshift.io/v1/authentications/{name}

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

name

string

認証の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
認証の削除
Expand
表2.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表2.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された認証を読み取る
Expand
表2.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表2.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表2.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.20 ボディーパラメーター
パラメーター説明

body

Authentication スキーマ

 
Expand
表2.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

201 - Created

Authentication スキーマ

401 - Unauthorized

空白

2.2.3. /apis/operator.openshift.io/v1/authentications/{name}/status

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

name

string

認証の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された認証のステータスを読み取ります
Expand
表2.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表2.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表2.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表2.30 ボディーパラメーター
パラメーター説明

body

Authentication スキーマ

 
Expand
表2.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Authentication スキーマ

201 - Created

Authentication スキーマ

401 - Unauthorized

空白

第3章 CloudCredential [operator.openshift.io/v1]

説明
CloudCredential は、CredentialsRequests を管理するように Operator を設定する手段を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

3.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

CloudCredentialSpec は、cloud-credential-operator の望ましい動作の仕様です。

status

object

CloudCredentialStatus は、cloud-credential-operator の監視ステータスを定義します。

3.1.1. .spec

説明
CloudCredentialSpec は、cloud-credential-operator の望ましい動作の仕様です。
object
Expand
プロパティータイプ説明

credentialsMode

string

CredentialsMode を使用すると、ルートクラウドのクレデンシャル機能を動的に決定しようとしてはならず、指定されたモードで実行する必要があることを CCO に通知できます。また、必要に応じて、Operator を "手動" モードにすることもできます。フィールドをデフォルトモードのままにすると、CCO が実行され、クラスターのクラウドクレデンシャルが (サポートされているクラウド/プラットフォームで) 機能に対して動的にプローブされます。サポートされているモード: AWS/Azure/GCP の場合は、"" (デフォルト)、"Mint"、"Passthrough"、"Manual" です。その他のプラットフォームでは、"Passthrough" での実行のみがサポートされているため、値を設定しないでください。

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

3.1.2. .status

説明
CloudCredentialStatus は、cloud-credential-operator の監視ステータスを定義します。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

3.1.3. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

3.1.4. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

3.1.5. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

3.1.6. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

3.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/cloudcredentials

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

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

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

3.2.1. /apis/operator.openshift.io/v1/cloudcredentials

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
CloudCredential のコレクションを削除します
Expand
表3.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表3.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
CloudCredential の種類のオブジェクトをリスト表示します
Expand
表3.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表3.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredentialList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.7 ボディーパラメーター
パラメーター説明

body

CloudCredential スキーマ

 
Expand
表3.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

201 - Created

CloudCredential スキーマ

202 - Accepted

CloudCredential スキーマ

401 - Unauthorized

空白

3.2.2. /apis/operator.openshift.io/v1/cloudcredentials/{name}

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

name

string

CloudCredential の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表3.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された CloudCredential を読み取ります
Expand
表3.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表3.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表3.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.20 ボディーパラメーター
パラメーター説明

body

CloudCredential スキーマ

 
Expand
表3.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

201 - Created

CloudCredential スキーマ

401 - Unauthorized

空白

3.2.3. /apis/operator.openshift.io/v1/cloudcredentials/{name}/status

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

name

string

CloudCredential の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された CloudCredential のステータスを読み取ります
Expand
表3.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表3.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表3.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表3.30 ボディーパラメーター
パラメーター説明

body

CloudCredential スキーマ

 
Expand
表3.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CloudCredential スキーマ

201 - Created

CloudCredential スキーマ

401 - Unauthorized

空白

第4章 ClusterCSIDriver [operator.openshift.io/v1]

説明
ClusterCSIDriver オブジェクトを使用すると、OpenShift にデフォルトでインストールされている CSI ドライバー Operator の管理と設定が可能になります。オブジェクトの名前は、それが動作する CSI ドライバーの名前である必要があります。許可される値のリストは、CSIDriverName タイプを参照してください。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

4.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

spec は、ユーザーが設定可能な設定値を保持します。

status

object

status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。

4.1.1. .spec

説明
spec は、ユーザーが設定可能な設定値を保持します。
object
Expand
プロパティータイプ説明

driverConfig

object

driverConfig は、プラットフォーム固有のドライバー設定を指定するために使用できます。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。これらのデフォルトは時間の経過とともに変更される可能性があります。

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

storageClassState

string

StorageClassState は、CSI Operator がストレージクラスを作成および管理する必要があるかどうかを決定します。このフィールドの値が空または Managed の場合、CSI Operator はストレージクラスを継続的に調整し、必要に応じて作成します。このフィールドの値が Unmanaged の場合、CSI Operator は以前に作成されたストレージクラスを調整しません。このフィールド値が Removed の場合、CSI Operator は以前に作成したストレージクラスを削除します。省略すると、ユーザーによる指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトの動作は Managed です。

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

4.1.2. .spec.driverConfig

説明
driverConfig は、プラットフォーム固有のドライバー設定を指定するために使用できます。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。これらのデフォルトは時間の経過とともに変更される可能性があります。
object
必須
  • driverType
Expand
プロパティータイプ説明

driverType

string

driverType は、driverConfig が適用される CSI ドライバーのタイプを示します。有効な値は次のとおりです。* vSphere は vsphere CSI ドライバートポロジーの設定を許可します。--- Consumers は不明な値を NO-OP として扱う必要があります。

vSphere

object

vsphere は、vsphere の CSI ドライバーを設定するために使用します。

4.1.3. .spec.driverConfig.vSphere

説明
vsphere は、vsphere の CSI ドライバーを設定するために使用します。
object
Expand
プロパティータイプ説明

topologyCategories

array (string)

topologyCategories は、hostcluster や datacenter などの vcenter リソースへのタグ付けに使用されるタグカテゴリーを示します。クラスターのインフラストラクチャーオブジェクトにトポロジーがある場合、インフラストラクチャーオブジェクトで指定されている値が使用され、topologyCategories への変更が拒否されます。

4.1.4. .status

説明
status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

4.1.5. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

4.1.6. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

4.1.7. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

4.1.8. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

4.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/clustercsidrivers

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

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

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

4.2.1. /apis/operator.openshift.io/v1/clustercsidrivers

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ClusterCSIDriver のコレクションを削除します
Expand
表4.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表4.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ClusterCSIDriver の種類のオブジェクトをリスト表示します
Expand
表4.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表4.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriverList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.7 ボディーパラメーター
パラメーター説明

body

ClusterCSIDriver スキーマ

 
Expand
表4.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

201 - Created

ClusterCSIDriver スキーマ

202 - Accepted

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

4.2.2. /apis/operator.openshift.io/v1/clustercsidrivers/{name}

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

name

string

ClusterCSIDriver の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表4.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ClusterCSIDriver を読み取ります
Expand
表4.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表4.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表4.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.20 ボディーパラメーター
パラメーター説明

body

ClusterCSIDriver スキーマ

 
Expand
表4.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

201 - Created

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

4.2.3. /apis/operator.openshift.io/v1/clustercsidrivers/{name}/status

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

name

string

ClusterCSIDriver の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された ClusterCSIDriver のステータスを読み取ります
Expand
表4.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表4.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表4.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表4.30 ボディーパラメーター
パラメーター説明

body

ClusterCSIDriver スキーマ

 
Expand
表4.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ClusterCSIDriver スキーマ

201 - Created

ClusterCSIDriver スキーマ

401 - Unauthorized

空白

第5章 Console [operator.openshift.io/v1]

説明
コンソールは、コンソールを管理するように Operator を設定する手段を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

5.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

ConsoleSpec は、コンソールの望ましい動作の仕様です。

status

object

ConsoleStatus は、コンソールの監視ステータスを定義します。

5.1.1. .spec

説明
ConsoleSpec は、コンソールの望ましい動作の仕様です。
object
Expand
プロパティータイプ説明

カスタマイズ

object

カスタマイズは、オプションで Web コンソールにカスタマイズオプションの小さなセットを提供するために使用されます。

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

plugins

array (string)

plugins は、有効なコンソールプラグイン名のリストを定義します。

providers

object

プロバイダーには、特定のサービスプロバイダーを使用するための設定が含まれています。

route

object

ルートには、サービング証明書を含むホスト名とシークレット参照が含まれています。カスタムルートが指定されている場合、指定されたホスト名で新しいルートが作成され、その下でコンソールを使用できます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。カスタムホスト名が任意のドメインを指している場合は、手動の DNS 設定手順が必要です。カスタムルートが削除された場合、コンソールのデフォルトのホスト名を予約するために、デフォルトのコンソールルートが維持されます。指定しない場合、デフォルトルートが使用されます。非推奨

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

5.1.2. .spec.customization

説明
customization は、必要に応じて少数のカスタマイズオプションを Web コンソールに提供するために使用します。
object
Expand
プロパティータイプ説明

addPage

object

addPage を使用すると、開発者の観点から追加ページのアクションをカスタマイズできます。

brand

string

ブランドは Web コンソールのデフォルトのブランドであり、ブランドフィールドを指定することで上書きできます。特定のブランドオプションの限られたセットがあります。このフィールドは、ロゴなどのコンソールの要素を制御します。値が無効な場合、コンソールのロールアウトが妨げられます。

customLogoFile

object

customLogoFile は、マストヘッドおよびアバウトダイアログのデフォルトの OpenShift ロゴを置き換えます。これは、openshift-config namespace 内の ConfigMap への参照です。これは、'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' のようなコマンドで作成できます。ConfigMap サイズの制約により、イメージサイズは 1MB 未満である必要があります。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。推奨されるロゴの仕様: 寸法: 最大高さ 68px、最大幅 200pxSVG 形式を推奨

customProductName

string

customProductName は、通常の OpenShift 製品名の代わりに、ページタイトル、ロゴの代替テキスト、およびバージョン情報ダイアログに表示される名前です。

developerCatalog

object

developerCatalog を使用すると、表示する開発者カタログのカテゴリー (フィルター) とタイプ (サブカタログ) を設定できます。

documentationBaseURL

string

外部ドキュメントへの documentationBaseURL リンクは、Web コンソールのさまざまなセクションに表示されます。documentationBaseURL を指定すると、デフォルトのドキュメント URL が上書きされます。値が無効な場合、コンソールのロールアウトが妨げられます。

perspectives

array

perspectives を使用すると、ユーザーがパースペクティブスイッチャードロップダウンで表示できるパースペクティブを有効/無効にすることができます。

perspectives[]

object

 

projectAccess

object

projectAccess を使用すると、開発者パースペクティブのプロジェクトアクセスページで利用可能な ClusterRoles のリストをカスタマイズできます。このページは、プロジェクト管理者が他のユーザーにロールを指定したり、プロジェクト内のアクセスを制限したりするために使用できます。設定されている場合、リストはデフォルトの ClusterRole オプションに置き換わります。

quickStarts

object

quickStarts を使用すると、コンソールで使用可能な ConsoleQuickStart リソースをカスタマイズできます。

5.1.3. .spec.customization.addPage

説明
addPage を使用すると、開発者の観点から追加ページのアクションをカスタマイズできます。
object
Expand
プロパティータイプ説明

disabledActions

array (string)

disabledActions は、ユーザーに表示されないアクションのリストです。リスト内の各アクションは、その ID で表されます。

5.1.4. .spec.customization.customLogoFile

説明
customLogoFile は、マストヘッドおよびアバウトダイアログのデフォルトの OpenShift ロゴを置き換えます。これは、openshift-config namespace 内の ConfigMap への参照です。これは、'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' のようなコマンドで作成できます。ConfigMap サイズの制約により、イメージサイズは 1MB 未満である必要があります。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。推奨されるロゴの仕様: 寸法: 最大高さ 68px、最大幅 200pxSVG 形式を推奨
object
Expand
プロパティータイプ説明

key

string

キーを使用すると、設定マップ内の特定のキー/値を指すことができます。これは、論理ファイルの参照に役立ちます。

name

string

 

5.1.5. .spec.customization.developerCatalog

説明
developerCatalog を使用すると、表示する開発者カタログのカテゴリー (フィルター) とタイプ (サブカタログ) を設定できます。
object
Expand
プロパティータイプ説明

categories

array

開発者カタログに表示されているカテゴリー。

categories[]

object

開発者コンソールカタログの DeveloperConsoleCatalogCategory。

types

object

types を使用すると、開発者カタログでユーザーが表示できるサブカタログタイプを有効または無効にすることができます。省略すると、すべてのサブカタログタイプが表示されます。

5.1.6. .spec.customization.developerCatalog.categories

説明
開発者カタログに表示されているカテゴリー。
array

5.1.7. .spec.customization.developerCatalog.categories[]

説明
開発者コンソールカタログの DeveloperConsoleCatalogCategory。
object
必須
  • id
  • ラベル
Expand
プロパティータイプ説明

id

string

ID は、コンソールでディープリンクを有効にするために URL で使用される識別子です。ID は必須であり、1〜32 の URL セーフ (AZ、az、0〜9、-、および _) 文字が必要です。

ラベル

string

label は、カテゴリー表示ラベルを定義します。必須であり、1〜64 文字である必要があります。

subcategories

array

サブカテゴリーは、子カテゴリーのリストを定義します。

subcategories[]

object

DeveloperConsoleCatalogCategoryMeta は、開発者カタログカテゴリーの主要な識別子です。

tags

array (string)

タグは、カテゴリーに一致する文字列のリストです。選択したカテゴリーには、カテゴリーとアイテムの間に少なくとも 1 つの重複するタグがあるすべてのアイテムが表示されます。

5.1.8. .spec.customization.developerCatalog.categories[].subcategories

説明
サブカテゴリーは、子カテゴリーのリストを定義します。
array

5.1.9. .spec.customization.developerCatalog.categories[].subcategories[]

説明
DeveloperConsoleCatalogCategoryMeta は、開発者カタログカテゴリーの主要な識別子です。
object
必須
  • id
  • ラベル
Expand
プロパティータイプ説明

id

string

ID は、コンソールでディープリンクを有効にするために URL で使用される識別子です。ID は必須であり、1〜32 の URL セーフ (AZ、az、0〜9、-、および _) 文字が必要です。

ラベル

string

label は、カテゴリー表示ラベルを定義します。必須であり、1〜64 文字である必要があります。

tags

array (string)

タグは、カテゴリーに一致する文字列のリストです。選択したカテゴリーには、カテゴリーとアイテムの間に少なくとも 1 つの重複するタグがあるすべてのアイテムが表示されます。

5.1.10. .spec.customization.developerCatalog.types

説明
types を使用すると、開発者カタログでユーザーが表示できるサブカタログタイプを有効または無効にすることができます。省略すると、すべてのサブカタログタイプが表示されます。
object
必須
  • state
Expand
プロパティータイプ説明

disabled

array (string)

disabled は、ユーザーに表示されない開発者カタログのタイプ (サブカタログ ID) のリストです。タイプ (サブカタログ) は、コンソールプラグインを介して追加されます。使用可能なタイプ (サブカタログ ID) は、コンソールのクラスター設定ページ、またはコンソールで YAML を編集するときに使用できます。たとえば、"Devfile"、"HelmChart"、"BuilderImage" です。リストが空の場合、または使用可能なサブカタログタイプがすべて追加されている場合は、開発者カタログ全体が非表示になります。

enabled

array (string)

enabled は、ユーザーに表示される開発者カタログのタイプ (サブカタログ ID) のリストです。タイプ (サブカタログ) は、コンソールプラグインを介して追加されます。使用可能なタイプ (サブカタログ ID) は、コンソールのクラスター設定ページ、またはコンソールで YAML を編集するときに使用できます。たとえば、"Devfile"、"HelmChart"、"BuilderImage" です。リストが空でない場合、新しいタイプはリストに追加されるまでユーザーに表示されません。リストが空の場合、開発者カタログ全体が表示されます。

state

string

state は、カタログタイプのリストを有効にするか無効にするかを定義します。

5.1.11. .spec.customization.perspectives

説明
perspectives を使用すると、ユーザーがパースペクティブスイッチャードロップダウンで表示できるパースペクティブを有効/無効にすることができます。
array

5.1.12. .spec.customization.perspectives[]

説明
object
必須
  • id
  • visibility
Expand
プロパティータイプ説明

id

string

id は、パースペクティブの ID を定義します。たとえば、"dev"、"admin" です。利用可能なパースペクティブ ID は、yaml エディターの横にあるコードスニペットセクションにあります。不正確または不明な ID は無視されます。

visibility

object

visibility は、パースペクティブの状態と、アクセスレビューチェック (そのパースペクティブに必要な場合) を定義します。

5.1.13. .spec.customization.perspectives[].visibility

説明
visibility は、パースペクティブの状態と、アクセスレビューチェック (そのパースペクティブに必要な場合) を定義します。
object
必須
  • state
Expand
プロパティータイプ説明

accessReview

object

accessReview は、必要なアクセスレビューチェックと不足しているアクセスレビューチェックを定義します。

state

string

state は、パースペクティブが有効か無効か、またはアクセスレビューチェックが必要かどうかを定義します。

5.1.14. .spec.customization.perspectives[].visibility.accessReview

説明
accessReview は、必要なアクセスレビューチェックと不足しているアクセスレビューチェックを定義します。
object
Expand
プロパティータイプ説明

missing

array

missing は、権限チェックのリストを定義します。1 つ以上のチェックが失敗した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、必要なアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。

missing[]

object

ResourceAttributes には、Authorizer インターフェイスへのリソースリクエストに使用できる許可属性が含まれています

required

array

required は、権限チェックのリストを定義します。すべてのチェックが成功した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、不足しているアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。

required[]

object

ResourceAttributes には、Authorizer インターフェイスへのリソースリクエストに使用できる許可属性が含まれています

5.1.15. .spec.customization.perspectives[].visibility.accessReview.missing

説明
missing は、権限チェックのリストを定義します。1 つ以上のチェックが失敗した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、必要なアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。
array

5.1.16. .spec.customization.perspectives[].visibility.accessReview.missing[]

説明
ResourceAttributes には、Authorizer インターフェイスへのリソースリクエストに使用できる許可属性が含まれています
object
Expand
プロパティータイプ説明

group

string

グループは、リソースの API グループです。"*" はすべてを意味します。

name

string

name は、"取得" のためにリクエストされているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。

namespace

string

namespace は、リクエストされているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。

resource

string

resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。

subresource

string

subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。

verb

string

verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。

version

string

バージョンは、リソースの API バージョンです。"*" はすべてを意味します。

5.1.17. .spec.customization.perspectives[].visibility.accessReview.required

説明
required は、権限チェックのリストを定義します。すべてのチェックが成功した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、不足しているアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。
array

5.1.18. .spec.customization.perspectives[].visibility.accessReview.required[]

説明
ResourceAttributes には、Authorizer インターフェイスへのリソースリクエストに使用できる許可属性が含まれています
object
Expand
プロパティータイプ説明

group

string

グループは、リソースの API グループです。"*" はすべてを意味します。

name

string

name は、"取得" のためにリクエストされているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。

namespace

string

namespace は、リクエストされているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。

resource

string

resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。

subresource

string

subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。

verb

string

verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。

version

string

バージョンは、リソースの API バージョンです。"*" はすべてを意味します。

5.1.19. .spec.customization.projectAccess

説明
projectAccess を使用すると、開発者パースペクティブのプロジェクトアクセスページで利用可能な ClusterRoles のリストをカスタマイズできます。このページは、プロジェクト管理者が他のユーザーにロールを指定したり、プロジェクト内のアクセスを制限したりするために使用できます。設定されている場合、リストはデフォルトの ClusterRole オプションに置き換わります。
object
Expand
プロパティータイプ説明

availableClusterRoles

array (string)

availableClusterRoles は、プロジェクトアクセスタブを介してユーザーに割り当てることができる ClusterRole 名のリストです。

5.1.20. .spec.customization.quickStarts

説明
quickStarts を使用すると、コンソールで使用可能な ConsoleQuickStart リソースをカスタマイズできます。
object
Expand
プロパティータイプ説明

disabled

array (string)

無効は、ユーザーに表示されない ConsoleQuickStart リソース名のリストです。

5.1.21. .spec.providers

説明
プロバイダーには、特定のサービスプロバイダーを使用するための設定が含まれています。
object
Expand
プロパティータイプ説明

statuspage

object

statuspage には、ステータス情報を提供する statuspage.io ページの ID が含まれています。

5.1.22. .spec.providers.statuspage

説明
statuspage には、ステータス情報を提供する statuspage.io ページの ID が含まれています。
object
Expand
プロパティータイプ説明

pageID

string

pageID は、Statuspage によってページに割り当てられた一意の ID です。これは公開ページである必要があります。

5.1.23. .spec.route

説明
ルートには、サービング証明書を含むホスト名とシークレット参照が含まれています。カスタムルートが指定されている場合、指定されたホスト名で新しいルートが作成され、その下でコンソールを使用できます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。カスタムホスト名が任意のドメインを指している場合は、手動の DNS 設定手順が必要です。カスタムルートが削除された場合、コンソールのデフォルトのホスト名を予約するために、デフォルトのコンソールルートが維持されます。指定しない場合、デフォルトルートが使用されます。非推奨
object
Expand
プロパティータイプ説明

hostname

string

ホスト名は、コンソールを使用できる目的のカスタムドメインです。

secret

object

secret は、カスタムの証明書と鍵が含まれる openshift-config namespace 内のシークレットを参照します。シークレットはクラスター管理者が手動で作成する必要があります。参照されるシークレットには、次のキー値のペアが含まれている必要があります。- "tls.crt" - カスタム証明書を指定します。- "tls.key" - カスタム証明書の秘密鍵を指定します。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット仕様は必要ありません。

5.1.24. .spec.route.secret

説明
secret は、カスタムの証明書と鍵が含まれる openshift-config namespace 内のシークレットを参照します。シークレットはクラスター管理者が手動で作成する必要があります。参照されるシークレットには、次のキー値のペアが含まれている必要があります。- "tls.crt" - カスタム証明書を指定します。- "tls.key" - カスタム証明書の秘密鍵を指定します。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット仕様は必要ありません。
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照されるシークレットの metadata.name です。

5.1.25. .status

説明
ConsoleStatus は、コンソールの監視ステータスを定義します。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

5.1.26. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

5.1.27. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

5.1.28. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

5.1.29. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

5.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/consoles

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

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

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

5.2.1. /apis/operator.openshift.io/v1/consoles

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表5.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示するコンソール
Expand
表5.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表5.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ConsoleList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
コンソールを作成する
Expand
表5.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.7 ボディーパラメーター
パラメーター説明

body

Console スキーマ

 
Expand
表5.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

201 - Created

Console スキーマ

202 - Accepted

Console スキーマ

401 - Unauthorized

空白

5.2.2. /apis/operator.openshift.io/v1/consoles/{name}

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

name

string

コンソールの名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
コンソールを削除する
Expand
表5.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表5.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたコンソールを読む
Expand
表5.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表5.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表5.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたコンソールを交換してください
Expand
表5.19 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.20 ボディーパラメーター
パラメーター説明

body

Console スキーマ

 
Expand
表5.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

201 - Created

Console スキーマ

401 - Unauthorized

空白

5.2.3. /apis/operator.openshift.io/v1/consoles/{name}/status

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

name

string

コンソールの名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定されたコンソールのステータスを読み取ります
Expand
表5.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表5.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表5.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表5.30 ボディーパラメーター
パラメーター説明

body

Console スキーマ

 
Expand
表5.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Console スキーマ

201 - Created

Console スキーマ

401 - Unauthorized

空白

第6章 Config [operator.openshift.io/v1]

説明
Config は、クラスター上に他のコンポーネントの初期設定を作成する役割を担う config Operator の動作を指定します。この Operator は、AWS および Azure クラウドをベースとしたクラスターのクラウド設定のインストール、移行、または同期も処理します。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object
必須
  • spec

6.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

spec は、Config Operator の望ましい動作の仕様です。

status

object

status は、Config Operator の監視ステータスを定義します。

6.1.1. .spec

説明
spec は、Config Operator の望ましい動作の仕様です。
object
Expand
プロパティータイプ説明

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

6.1.2. .status

説明
status は、Config Operator の監視ステータスを定義します。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

6.1.3. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

6.1.4. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

6.1.5. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

6.1.6. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

6.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/configs

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

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

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

6.2.1. /apis/operator.openshift.io/v1/configs

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
Config のコレクションを削除します
Expand
表6.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表6.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する Config
Expand
表6.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表6.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ConfigList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
設定を作成する
Expand
表6.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表6.7 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表6.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

202 - Accepted

Config スキーマ

401 - Unauthorized

空白

6.2.2. /apis/operator.openshift.io/v1/configs/{name}

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

name

string

設定の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
設定を削除する
Expand
表6.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表6.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された設定を読み取ります
Expand
表6.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表6.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表6.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表6.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表6.20 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表6.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

401 - Unauthorized

空白

6.2.3. /apis/operator.openshift.io/v1/configs/{name}/status

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

name

string

設定の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された設定のステータスを読み取ります
Expand
表6.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表6.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表6.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表6.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表6.30 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表6.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

401 - Unauthorized

空白

第7章 Config [imageregistry.operator.openshift.io/v1]

説明
Config は、レジストリー Operator によって管理されるレジストリーインスタンスの設定オブジェクトです。互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object
必須
  • metadata
  • spec

7.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

ImageRegistrySpec は、実行中のレジストリーの仕様を定義します。

status

object

ImageRegistryStatus は、イメージレジストリーの動作ステータスを報告します。

7.1.1. .spec

説明
ImageRegistrySpec は、実行中のレジストリーの仕様を定義します。
object
必須
  • replicas
Expand
プロパティータイプ説明

affinity

object

アフィニティーは、イメージレジストリー Pod のノードアフィニティースケジューリングルールのグループです。

defaultRoute

boolean

defaultRoute は、デフォルトで生成されたホスト名を使用して、レジストリーの外部向けルートを作成する必要があるかどうかを示します。

disableRedirect

boolean

disableRedirect は、バックエンドにリダイレクトするのではなく、レジストリーを介してすべてのデータをルーティングするかどうかを制御します。

httpSecret

string

httpSecret は、レジストリーがアップロードを保護するために必要な値であり、デフォルトで生成されます。

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

logging

integer

ロギングは非推奨です。代わりに logLevel を使用してください。

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

nodeSelector

object (string)

nodeSelector は、レジストリー Pod のノード選択制約を定義します。

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

proxy

object

proxy は、マスター API、アップストリームレジストリーなどを呼び出すときに使用されるプロキシーを定義します。

readOnly

boolean

readOnly は、レジストリーインスタンスが新しいイメージのプッシュや既存のイメージの削除を拒否するかどうかを指定します。

replicas

integer

レプリカは、実行するレジストリーインスタンスの数を決定します。

requests

object

指定されたレジストリーインスタンスが追加リソースをキューに入れる前に処理する並列リクエストの数を制御します。

resources

object

resources は、レジストリー Pod のリソースリクエストと制限を定義します。

rolloutStrategy

string

rolloutStrategy は、イメージレジストリーデプロイメントのロールアウト戦略を定義します。

routes

array

ルートは、レジストリー用に作成する必要がある追加の外部向けルートを定義します。

routes[]

object

ImageRegistryConfigRoute は、イメージレジストリーへの外部ルートアクセスに関する情報を保持します。

storage

object

レジストリーストレージを設定するためのストレージの詳細 (S3 バケット座標など)。

tolerations

array

tolerations は、レジストリー Pod の許容値を定義します。

tolerations[]

object

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

topologySpreadConstraints

array

topologySpreadConstraints は、一致する Pod を特定のトポロジー内でどのように分散するかを指定します。

topologySpreadConstraints[]

object

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

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

7.1.2. .spec.affinity

説明
アフィニティーは、イメージレジストリー Pod のノードアフィニティースケジューリングルールのグループです。
object
Expand
プロパティータイプ説明

nodeAffinity

object

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

podAffinity

object

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

podAntiAffinity

object

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

7.1.3. .spec.affinity.nodeAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

object

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

7.1.4. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

7.1.5. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

preference

object

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

weight

integer

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

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

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

matchExpressions

array

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

matchExpressions[]

object

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

matchFields

array

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

matchFields[]

object

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

nodeSelectorTerms

array

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

nodeSelectorTerms[]

object

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

7.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

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

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

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

matchExpressions

array

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

matchExpressions[]

object

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

matchFields

array

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

matchFields[]

object

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.18. .spec.affinity.podAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

array

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

requiredDuringSchedulingIgnoredDuringExecution[]

object

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

7.1.19. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

7.1.20. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

podAffinityTerm

object

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

weight

integer

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

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

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.28. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

7.1.29. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.36. .spec.affinity.podAntiAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

array

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

requiredDuringSchedulingIgnoredDuringExecution[]

object

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

7.1.37. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

7.1.38. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

podAffinityTerm

object

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

weight

integer

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

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

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.46. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

7.1.47. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

7.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

7.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

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

key

string

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

operator

string

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

values

array (string)

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

7.1.54. .spec.proxy

説明
proxy は、マスター API、アップストリームレジストリーなどを呼び出すときに使用されるプロキシーを定義します。
object
Expand
プロパティータイプ説明

http

string

http は、HTTP エンドポイントにアクセスするときにイメージレジストリーによって使用されるプロキシーを定義します。

https

string

https は、HTTPS エンドポイントにアクセスするときにイメージレジストリーによって使用されるプロキシーを定義します。

noProxy

string

noProxy は、プロキシーを通過してはならないホスト名のコンマ区切りリストを定義します。

7.1.55. .spec.requests

説明
指定されたレジストリーインスタンスが追加リソースをキューに入れる前に処理する並列リクエストの数を制御します。
object
Expand
プロパティータイプ説明

read

object

read は、イメージレジストリーの読み取りの制限を定義します。

write

object

write は、イメージレジストリーの書き込みの制限を定義します。

7.1.56. .spec.requests.read

説明
read は、イメージレジストリーの読み取りの制限を定義します。
object
Expand
プロパティータイプ説明

maxInQueue

integer

maxInQueue は、キューに入れられた API リクエストの最大数をレジストリーに設定します。

maxRunning

integer

maxRunning は、飛行中の API リクエストの最大数をレジストリーに設定します。

maxWaitInQueue

string

maxWaitInQueue は、リクエストが拒否される前にキューで待機できる最大時間を設定します。

7.1.57. .spec.requests.write

説明
write は、イメージレジストリーの書き込みの制限を定義します。
object
Expand
プロパティータイプ説明

maxInQueue

integer

maxInQueue は、キューに入れられた API リクエストの最大数をレジストリーに設定します。

maxRunning

integer

maxRunning は、飛行中の API リクエストの最大数をレジストリーに設定します。

maxWaitInQueue

string

maxWaitInQueue は、リクエストが拒否される前にキューで待機できる最大時間を設定します。

7.1.58. .spec.resources

説明
resources は、レジストリー Pod のリソースリクエストと制限を定義します。
object
Expand
プロパティータイプ説明

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

7.1.59. .spec.routes

説明
ルートは、レジストリー用に作成する必要がある追加の外部向けルートを定義します。
array

7.1.60. .spec.routes[]

説明
ImageRegistryConfigRoute は、イメージレジストリーへの外部ルートアクセスに関する情報を保持します。
object
必須
  • name
Expand
プロパティータイプ説明

hostname

string

ルートのホスト名。

name

string

作成するルートの名前。

secretName

string

secretName は、ルートで使用される証明書を含むシークレットを指します。

7.1.61. .spec.storage

説明
レジストリーストレージを設定するためのストレージの詳細 (S3 バケット座標など)。
object
Expand
プロパティータイプ説明

azure

object

azure は、Azure Blob Storage を使用する設定を表します。

emptyDir

object

emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。

gcs

object

gcs は、Google Cloud Storage を使用する設定を表します。

ibmcos

object

ibmcos は、IBM Cloud Object Storage を使用する設定を表します。

managementState

string

managementState は、Operator が基礎となるストレージ装置を管理しているかどうかを示します。マネージドの場合、この Operator が削除されると、Operator はストレージを削除します。

oss

object

Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。

pvc

object

pvc は、PersistentVolumeClaim を使用する設定を表します。

s3

object

s3 は、Amazon Simple Storage Service を使用する設定を表します。

swift

object

swift は、OpenStack Object Storage を使用する設定を表します。

7.1.62. .spec.storage.azure

説明
azure は、Azure Blob Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

accountName

string

accountName は、レジストリーで使用されるアカウントを定義します。

cloudName

string

cloudName は、レジストリーで使用される Azure クラウド環境の名前です。空の場合、Operator はインフラストラクチャーオブジェクトに基づいて設定します。

container

string

コンテナーは、レジストリーで使用される Azure のコンテナーを定義します。

7.1.63. .spec.storage.emptyDir

説明
emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。
object

7.1.64. .spec.storage.gcs

説明
gcs は、Google Cloud Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。

keyID

string

keyID は、暗号化に使用する KMS キー ID です。オプションで、バケットは GCP でデフォルトで暗号化されます。これにより、カスタム暗号化キーを使用できます。

projectID

string

projectID は、このバケットが関連付けられる必要がある GCP プロジェクトのプロジェクト ID です。

region

string

リージョンは、バケットが存在する GCS の場所です。オプションで、インストールされている GCS リージョンに基づいて設定されます。

7.1.65. .spec.storage.ibmcos

説明
ibmcos は、IBM Cloud Object Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。

location

string

location は、バケットが存在する IBM Cloud の場所です。オプションで、インストールされている IBM Cloud の場所に基づいて設定されます。

resourceGroupName

string

resourceGroupName は、このバケットとそのサービスインスタンスが関連付けられている IBM Cloud リソースグループの名前です。オプションで、インストールされている IBM Cloud リソースグループに基づいて設定されます。

resourceKeyCRN

string

resourceKeyCRN は、サービスインスタンス用に作成された IBM Cloud リソースキーの CRN です。一般にサービスクレデンシャルと呼ばれ、HMAC タイプのクレデンシャルが含まれている必要があります。オプションで、提供されていない場合は計算されます。

serviceInstanceCRN

string

serviceInstanceCRN は、このバケットが関連付けられている IBM Cloud Object Storage サービスインスタンスの CRN です。オプションで、提供されていない場合は計算されます。

7.1.66. .spec.storage.oss

説明
Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

Bucket は、レジストリーのデータを保存するバケット名です。バケットの命名の詳細は、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/257087.htm) で確認できます。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは <clusterid>-image-registry-<リージョン>-<ランダムな 27 文字の文字列> という形式で自動生成されます。

encryption

object

Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。

endpointAccessibility

string

EndpointAccessibility は、レジストリーが OSS VPC 内部エンドポイントを使用するかどうかを指定します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは Internal です。

region

string

Region は、バケットが存在する Alibaba Cloud リージョンです。リージョンのリストは、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/31837.html) を参照してください。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトはインストールされている Alibaba Cloud リージョンに基づいています。

7.1.67. .spec.storage.oss.encryption

説明
Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。
object
Expand
プロパティータイプ説明

kms

object

KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。

method

string

Method は、利用可能なさまざまな暗号化モードを定義します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは AES256 です。

7.1.68. .spec.storage.oss.encryption.kms

説明
KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。
object
必須
  • keyID
Expand
プロパティータイプ説明

keyID

string

KeyID は、KMS の暗号鍵 ID を保持します。

7.1.69. .spec.storage.pvc

説明
pvc は、PersistentVolumeClaim を使用する設定を表します。
object
Expand
プロパティータイプ説明

claim

string

クレームは、使用される永続ボリュームクレームの名前を定義します。

7.1.70. .spec.storage.s3

説明
s3 は、Amazon Simple Storage Service を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。

cloudFront

object

cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。

encrypt

boolean

encrypt は、イメージが暗号化された形式で保存されるかどうかを指定します。オプションで、デフォルトは false です。

keyID

string

keyID は、暗号化に使用する KMS キー ID です。オプションで、暗号化は true である必要があります。そうでない場合、このパラメーターは無視されます。

region

string

リージョンはバケットが存在する AWS リージョンです。オプションで、インストールされている AWS リージョンに基づいて設定されます。

regionEndpoint

string

RegionEndpoint は、S3 互換のストレージサービスのエンドポイントです。オプションで、提供される地域に基づくデフォルト。

trustedCA

object

trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。

virtualHostedStyle

boolean

virtualHostedStyle を使用すると、カスタムの RegionEndpoint オプションで S3 仮想ホストスタイルバケットパスを使用できます。デフォルトは false です。

7.1.71. .spec.storage.s3.cloudFront

説明
cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。
object
必須
  • baseURL
  • keypairID
  • privateKey
Expand
プロパティータイプ説明

baseURL

string

baseURL には、Cloudfront が提供される SCHEME://HOST[/PATH] が含まれています。

duration

string

duration は、Cloudfront セッションの継続時間です。

keypairID

string

keypairID は、AWS が提供するキーペア ID です。

privateKey

object

privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。

7.1.72. .spec.storage.s3.cloudFront.privateKey

説明
privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。
object
必須
  • key
Expand
プロパティータイプ説明

key

string

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

name

string

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

任意

boolean

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

7.1.73. .spec.storage.s3.trustedCA

説明
trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。
object
Expand
プロパティータイプ説明

name

string

name は、参照される config map の metadata.name です。このフィールドは、標準の config map の命名制限に準拠する必要があります。名前は、英数字、ハイフン (-)、ピリオド (.) のみで構成する必要があります。最大長は 253 文字です。このフィールドが指定されていないか、空の文字列である場合、デフォルトのトラストバンドルが使用されます。

7.1.74. .spec.storage.swift

説明
swift は、OpenStack Object Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

authURL

string

authURL は、認証トークンを取得するための URL を定義します。

authVersion

string

authVersion は、OpenStack Auth のバージョンを指定します。

container

string

container は、レジストリーのデータを格納する Swift コンテナーの名前を定義します。

domain

string

domain は、Identityv3API の Openstack のドメイン名を指定します。

domainID

string

domainID は、Identityv3API の Openstack のドメイン ID を指定します。

regionName

string

regionName は、コンテナーが存在する Openstack のリージョンを定義します。

tenant

string

テナントは、レジストリーが使用する Openstack テナント名を定義します。

tenantID

string

テナントは、レジストリーが使用する Openstack テナント ID を定義します。

7.1.75. .spec.tolerations

説明
tolerations は、レジストリー Pod の許容値を定義します。
array

7.1.76. .spec.tolerations[]

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

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

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

7.1.77. .spec.topologySpreadConstraints

説明
topologySpreadConstraints は、一致する Pod を特定のトポロジー内でどのように分散するかを指定します。
array

7.1.78. .spec.topologySpreadConstraints[]

説明
topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。
object
必須
  • maxSkew
  • topologyKey
  • whenUnsatisfiable
Expand
プロパティータイプ説明

labelSelector

object

LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。

matchLabelKeys

array (string)

MatchLabelKeys は、分散を計算する Pod を選択するための Pod ラベルキーのセットです。このようなキーは受信 Pod のラベルから値を検索するために使用され、このキーと値のラベルは labelSelector と AND 演算されて、受信 Pod の分散が計算される既存の Pod のグループを選択します。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。

maxSkew

integer

MaxSkew は、Pod が不均一に分布している可能性の程度を表します。whenUnsatisfiable = DoNotSchedule の場合、これは、ターゲットトポロジー内の一致する Pod の数とグローバル最小値との間の最大許容差です。グローバル最小値は、適格なドメイン内で一致する Pod の最小数です。または、適格なドメインの数が MinDomains 未満の場合はゼロになります。たとえば、3 ゾーンクラスターでは、MaxSkew が 1 に設定され、同じ labelSelector を持つ Pod は 2/2/1 に分散されます。この場合、グローバル最小値は 1 です。| zone1 | zone2 | zone3 | | P P | P P | P | - MaxSkew が 1 の場合、受信 Pod は 2/2/2 になるように zone 3 にのみスケジュールできます。これを zone1(zone2) にスケジュールすると、zone1(zone2) の ActualSkew(3-1) が MaxSkew(1) に違反します。- MaxSkew が 2 の場合、受信 Pod を任意のゾーンにスケジュールできます。whenUnsatisfiable = ScheduleAnyway の場合、それを満たすトポロジーに高い優先順位を与えるために使用されます。必須フィールドです。デフォルト値は 1 で、0 は許可されていません。

minDomains

integer

MinDomains は、対象となるドメインの最小数を示します。トポロジーキーが一致する適格なドメインの数が minDomains より少ない場合、Pod Topology Spread は "グローバル最小値" を 0 として扱い、スキューの計算が実行されます。また、トポロジーキーが一致する適格なドメインの数が minDomains の数以上の場合、この値はスケジュールに影響しません。その結果、対象となるドメインの数が minDomains より少ない場合、スケジューラーはそれらのドメインに対して maxSkew を超える Pod をスケジュールしません。値が nil の場合、制約は MinDomains が 1 と等しいかのように動作します。有効な値は 0 より大きい整数です。値が nil でない場合、WhenUnsatisfiable は DoNotSchedule でなければなりません。たとえば、3 ゾーンクラスターの場合、MaxSkew は 2 に設定され、MinDomains は 5 に設定され、同じ labelSelector を持つ Pod は 2/2/2 に分散されます ( | zone1 | zone2 | zone3 | | P P | P | P | P P | P P | P P | P |)。ドメインの数は 5 (MinDomains 未満) であるため、"global minimum" は 0 として扱われます。このような場合、同じ labelSelector を持つ新しい Pod をスケジュールすることはできません。新しい Pod が 3 つのゾーンのいずれかにスケジュールされている場合、スキューは 3(3 - 0) と計算され、MaxSkew に違反するためです。これはベータフィールドであり、MinDomainsInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。

nodeAffinityPolicy

string

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

nodeTaintsPolicy

string

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

topologyKey

string

TopologyKey は、ノードラベルのキーです。このキーと同じ値のラベルを持つノードは、同じトポロジーにあると見なされます。各 <key, value> を "バケット" と見なし、バランスの取れた数の Pod を各バケットに配置しようとします。ドメインをトポロジーの特定のインスタンスとして定義します。また、ノードが nodeAffinityPolicy および nodeTaintsPolicy の要件を満たすドメインとして、適格なドメインを定義します。たとえば、TopologyKey が "kubernetes.io/hostname" の場合、各ノードはそのトポロジーのドメインです。また、TopologyKey が "topology.kubernetes.io/zone" の場合は、各ゾーンがそのトポロジーのドメインになります。必須フィールドです。

whenUnsatisfiable

string

WhenUnsatisfiable は、スプレッドの制約を満たさない場合に Pod を処理する方法を示します。-DoNotSchedule (デフォルト) は、スケジューラーにスケジュールしないように指示します。--ScheduleAnyway は、任意の場所で Pod をスケジュールするようにスケジューラーに指示しますが、スキューを減らすのに役立つトポロジーに高い優先順位を与えます。受信 Pod に対する制約は、対象となる Pod へのノード割り当て候補すべてがトポロジーの一部の "MaxSkew" に違反する場合に、"Unsatisfiable" とみなされます。たとえば、3 ゾーンクラスターでは、MaxSkew は 1 に設定され、labelSelector が同じ Pod は 3/1/1 ( | zone1 | zone2 | zone3 | | P P P | P | P |) に分散されます。WhenUnsatisfiable が DoNotSchedule に設定されている場合、zone2(zone3) の ActualSkew(2-1) が MaxSkew(1) を満たすため、受信 Pod は zone2(zone3) にのみスケジュールして 3/2/1(3/1/2) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。

7.1.79. .spec.topologySpreadConstraints[].labelSelector

説明
LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

7.1.80. .spec.topologySpreadConstraints[].labelSelector.matchExpressions

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

7.1.81. .spec.topologySpreadConstraints[].labelSelector.matchExpressions[]

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

key

string

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

operator

string

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

values

array (string)

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

7.1.82. .status

説明
ImageRegistryStatus は、イメージレジストリーの動作ステータスを報告します。
object
必須
  • storage
  • storageManaged
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

storage

object

storage は、レジストリーの現在適用されているストレージ設定を示します。

storageManaged

boolean

storageManaged は非推奨です。Storage.managementState を参照してください

version

string

バージョンは、この可用性が適用されるレベルです

7.1.83. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

7.1.84. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

7.1.85. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

7.1.86. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

7.1.87. .status.storage

説明
storage は、レジストリーの現在適用されているストレージ設定を示します。
object
Expand
プロパティータイプ説明

azure

object

azure は、Azure Blob Storage を使用する設定を表します。

emptyDir

object

emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。

gcs

object

gcs は、Google Cloud Storage を使用する設定を表します。

ibmcos

object

ibmcos は、IBM Cloud Object Storage を使用する設定を表します。

managementState

string

managementState は、Operator が基礎となるストレージ装置を管理しているかどうかを示します。マネージドの場合、この Operator が削除されると、Operator はストレージを削除します。

oss

object

Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。

pvc

object

pvc は、PersistentVolumeClaim を使用する設定を表します。

s3

object

s3 は、Amazon Simple Storage Service を使用する設定を表します。

swift

object

swift は、OpenStack Object Storage を使用する設定を表します。

7.1.88. .status.storage.azure

説明
azure は、Azure Blob Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

accountName

string

accountName は、レジストリーで使用されるアカウントを定義します。

cloudName

string

cloudName は、レジストリーで使用される Azure クラウド環境の名前です。空の場合、Operator はインフラストラクチャーオブジェクトに基づいて設定します。

container

string

コンテナーは、レジストリーで使用される Azure のコンテナーを定義します。

7.1.89. .status.storage.emptyDir

説明
emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。
object

7.1.90. .status.storage.gcs

説明
gcs は、Google Cloud Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。

keyID

string

keyID は、暗号化に使用する KMS キー ID です。オプションで、バケットは GCP でデフォルトで暗号化されます。これにより、カスタム暗号化キーを使用できます。

projectID

string

projectID は、このバケットが関連付けられる必要がある GCP プロジェクトのプロジェクト ID です。

region

string

リージョンは、バケットが存在する GCS の場所です。オプションで、インストールされている GCS リージョンに基づいて設定されます。

7.1.91. .status.storage.ibmcos

説明
ibmcos は、IBM Cloud Object Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。

location

string

location は、バケットが存在する IBM Cloud の場所です。オプションで、インストールされている IBM Cloud の場所に基づいて設定されます。

resourceGroupName

string

resourceGroupName は、このバケットとそのサービスインスタンスが関連付けられている IBM Cloud リソースグループの名前です。オプションで、インストールされている IBM Cloud リソースグループに基づいて設定されます。

resourceKeyCRN

string

resourceKeyCRN は、サービスインスタンス用に作成された IBM Cloud リソースキーの CRN です。一般にサービスクレデンシャルと呼ばれ、HMAC タイプのクレデンシャルが含まれている必要があります。オプションで、提供されていない場合は計算されます。

serviceInstanceCRN

string

serviceInstanceCRN は、このバケットが関連付けられている IBM Cloud Object Storage サービスインスタンスの CRN です。オプションで、提供されていない場合は計算されます。

7.1.92. .status.storage.oss

説明
Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

Bucket は、レジストリーのデータを保存するバケット名です。バケットの命名の詳細は、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/257087.htm) で確認できます。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは <clusterid>-image-registry-<リージョン>-<ランダムな 27 文字の文字列> という形式で自動生成されます。

encryption

object

Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。

endpointAccessibility

string

EndpointAccessibility は、レジストリーが OSS VPC 内部エンドポイントを使用するかどうかを指定します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは Internal です。

region

string

Region は、バケットが存在する Alibaba Cloud リージョンです。リージョンのリストは、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/31837.html) を参照してください。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトはインストールされている Alibaba Cloud リージョンに基づいています。

7.1.93. .status.storage.oss.encryption

説明
Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。
object
Expand
プロパティータイプ説明

kms

object

KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。

method

string

Method は、利用可能なさまざまな暗号化モードを定義します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは AES256 です。

7.1.94. .status.storage.oss.encryption.kms

説明
KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。
object
必須
  • keyID
Expand
プロパティータイプ説明

keyID

string

KeyID は、KMS の暗号鍵 ID を保持します。

7.1.95. .status.storage.pvc

説明
pvc は、PersistentVolumeClaim を使用する設定を表します。
object
Expand
プロパティータイプ説明

claim

string

クレームは、使用される永続ボリュームクレームの名前を定義します。

7.1.96. .status.storage.s3

説明
s3 は、Amazon Simple Storage Service を使用する設定を表します。
object
Expand
プロパティータイプ説明

bucket

string

バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。

cloudFront

object

cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。

encrypt

boolean

encrypt は、イメージが暗号化された形式で保存されるかどうかを指定します。オプションで、デフォルトは false です。

keyID

string

keyID は、暗号化に使用する KMS キー ID です。オプションで、暗号化は true である必要があります。そうでない場合、このパラメーターは無視されます。

region

string

リージョンはバケットが存在する AWS リージョンです。オプションで、インストールされている AWS リージョンに基づいて設定されます。

regionEndpoint

string

RegionEndpoint は、S3 互換のストレージサービスのエンドポイントです。オプションで、提供される地域に基づくデフォルト。

trustedCA

object

trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。

virtualHostedStyle

boolean

virtualHostedStyle を使用すると、カスタムの RegionEndpoint オプションで S3 仮想ホストスタイルバケットパスを使用できます。デフォルトは false です。

7.1.97. .status.storage.s3.cloudFront

説明
cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。
object
必須
  • baseURL
  • keypairID
  • privateKey
Expand
プロパティータイプ説明

baseURL

string

baseURL には、Cloudfront が提供される SCHEME://HOST[/PATH] が含まれています。

duration

string

duration は、Cloudfront セッションの継続時間です。

keypairID

string

keypairID は、AWS が提供するキーペア ID です。

privateKey

object

privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。

7.1.98. .status.storage.s3.cloudFront.privateKey

説明
privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。
object
必須
  • key
Expand
プロパティータイプ説明

key

string

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

name

string

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

任意

boolean

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

7.1.99. .status.storage.s3.trustedCA

説明
trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。
object
Expand
プロパティータイプ説明

name

string

name は、参照される config map の metadata.name です。このフィールドは、標準の config map の命名制限に準拠する必要があります。名前は、英数字、ハイフン (-)、ピリオド (.) のみで構成する必要があります。最大長は 253 文字です。このフィールドが指定されていないか、空の文字列である場合、デフォルトのトラストバンドルが使用されます。

7.1.100. .status.storage.swift

説明
swift は、OpenStack Object Storage を使用する設定を表します。
object
Expand
プロパティータイプ説明

authURL

string

authURL は、認証トークンを取得するための URL を定義します。

authVersion

string

authVersion は、OpenStack Auth のバージョンを指定します。

container

string

container は、レジストリーのデータを格納する Swift コンテナーの名前を定義します。

domain

string

domain は、Identityv3API の Openstack のドメイン名を指定します。

domainID

string

domainID は、Identityv3API の Openstack のドメイン ID を指定します。

regionName

string

regionName は、コンテナーが存在する Openstack のリージョンを定義します。

tenant

string

テナントは、レジストリーが使用する Openstack テナント名を定義します。

tenantID

string

テナントは、レジストリーが使用する Openstack テナント ID を定義します。

7.2. API エンドポイント

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

  • /apis/imageregistry.operator.openshift.io/v1/configs

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

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

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

7.2.1. /apis/imageregistry.operator.openshift.io/v1/configs

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
Config のコレクションを削除します
Expand
表7.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表7.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する Config
Expand
表7.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表7.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ConfigList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
設定を作成する
Expand
表7.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表7.7 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表7.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

202 - Accepted

Config スキーマ

401 - Unauthorized

空白

7.2.2. /apis/imageregistry.operator.openshift.io/v1/configs/{name}

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

name

string

設定の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
設定を削除する
Expand
表7.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表7.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された設定を読み取ります
Expand
表7.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表7.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表7.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表7.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表7.20 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表7.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

401 - Unauthorized

空白

7.2.3. /apis/imageregistry.operator.openshift.io/v1/configs/{name}/status

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

name

string

設定の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された設定のステータスを読み取ります
Expand
表7.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表7.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表7.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表7.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表7.30 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表7.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

401 - Unauthorized

空白

第8章 Config [samples.operator.openshift.io/v1]

説明
Config には、SamplesOperator の設定と詳細な条件ステータスが含まれています。
タイプ
object
必須
  • metadata
  • spec

8.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

ConfigSpec には、Samples Operator に必要な設定と状態が含まれています。これにより、openshift namespace で作成/更新されるイメージストリームとテンプレートに関するさまざまな動作が制御されます。

status

object

ConfigStatus には、実際の設定と、サンプル Operator の状態を説明するさまざまな詳細が含まれています。

8.1.1. .spec

説明
ConfigSpec には、Samples Operator に必要な設定と状態が含まれています。これにより、openshift namespace で作成/更新されるイメージストリームとテンプレートに関するさまざまな動作が制御されます。
object
Expand
プロパティータイプ説明

architectures

array (string)

アーキテクチャーは、インストールするハードウェアアーキテクチャーを決定します。現在サポートされている選択肢は、x86_64、ppc64le、および s390x のみです。

managementState

string

managementState は、すべての Operator にとって最上位のオン/オフタイプのスイッチです。"Managed" の場合、この Operator は設定を処理し、それに応じてサンプルを操作します。"Unmanaged" 場合、この Operator は監視しているリソースの更新を無視します。"Removed" の場合、Operator は Config オブジェクトが削除された場合と同じように反応します。つまり、Operator が (スキップ対象のリストに従って) 管理する ImageStream またはテンプレートとレジストリーシークレットが、Operator の namespace 内にある、サンプルの操作に最後に使用された設定を表す ConfigMap とともに削除されます。

samplesRegistry

string

samplesRegistry を使用すると、ImageStreams がイメージコンテンツのためにアクセスするレジストリーを指定できます。この github リポジトリーにプルされる https://github.com/openshift/library のコンテンツのデフォルトですが、ocp コンテンツのみのプルに基づいて、通常はデフォルトで registry.redhat.io になります。

skippedImagestreams

array (string)

skippedImagestreams は、作成/更新してはならないイメージストリームの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。

skippedTemplates

array (string)

skippedTemplates は、作成/更新してはならないテンプレートの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。

8.1.2. .status

説明
ConfigStatus には、実際の設定と、サンプル Operator の状態を説明するさまざまな詳細が含まれています。
object
Expand
プロパティータイプ説明

architectures

array (string)

アーキテクチャーは、インストールするハードウェアアーキテクチャーを決定します。ここで、x86_64 と ppc64le がサポートされている選択肢です。

conditions

array

条件は、サンプルイメージストリームとテンプレートの利用可能なメンテナンスステータスを表します。

conditions[]

object

ConfigCondition は、エントリーが処理されるときに Config のさまざまな条件をキャプチャします。

managementState

string

managementState は、Operator のオン/オフスイッチの現在の動作ステータスを反映します。この Operator は、Operator をオンに戻していることを確認する一環として、ManagementState を比較します (つまり、以前は "アンマネージド" の場合は "マネージド")。

samplesRegistry

string

samplesRegistry を使用すると、ImageStreams がイメージコンテンツのためにアクセスするレジストリーを指定できます。この github リポジトリーにプルされる https://github.com/openshift/library のコンテンツのデフォルトですが、ocp コンテンツのみのプルに基づいて、通常はデフォルトで registry.redhat.io になります。

skippedImagestreams

array (string)

skippedImagestreams は、作成/更新してはならないイメージストリームの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。

skippedTemplates

array (string)

skippedTemplates は、作成/更新してはならないテンプレートの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。

version

string

version は、最後に正常に処理されたときの Operator のペイロードベースのバージョンインジケーターの値です。

8.1.3. .status.conditions

説明
条件は、サンプルイメージストリームとテンプレートの利用可能なメンテナンスステータスを表します。
array

8.1.4. .status.conditions[]

説明
ConfigCondition は、エントリーが処理されるときに Config のさまざまな条件をキャプチャします。
object
必須
  • status
  • type
Expand
プロパティータイプ説明

lastTransitionTime

string

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

lastUpdateTime

string

lastUpdateTime は、この条件が最後に更新された時刻です。

message

string

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

reason

string

理由は、条件の最後の遷移を引き起こしたものです。

status

string

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

type

string

状態のタイプ。

8.2. API エンドポイント

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

  • /apis/samples.operator.openshift.io/v1/configs

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

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

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

8.2.1. /apis/samples.operator.openshift.io/v1/configs

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
Config のコレクションを削除します
Expand
表8.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表8.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する Config
Expand
表8.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表8.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ConfigList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
設定を作成する
Expand
表8.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表8.7 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表8.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

202 - Accepted

Config スキーマ

401 - Unauthorized

空白

8.2.2. /apis/samples.operator.openshift.io/v1/configs/{name}

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

name

string

設定の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
設定を削除する
Expand
表8.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表8.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された設定を読み取ります
Expand
表8.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表8.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表8.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表8.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表8.20 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表8.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

401 - Unauthorized

空白

8.2.3. /apis/samples.operator.openshift.io/v1/configs/{name}/status

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

name

string

設定の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された設定のステータスを読み取ります
Expand
表8.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表8.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表8.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表8.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表8.30 ボディーパラメーター
パラメーター説明

body

Config スキーマ

 
Expand
表8.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Config スキーマ

201 - Created

Config スキーマ

401 - Unauthorized

空白

第9章 CSISnapshotController [operator.openshift.io/v1]

説明
CSISnapshotController は、CSI スナップショットを管理するように Operator を設定する手段を提供します。cluster は正規名です。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

9.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

spec は、ユーザーが設定可能な設定値を保持します。

status

object

status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。

9.1.1. .spec

説明
spec は、ユーザーが設定可能な設定値を保持します。
object
Expand
プロパティータイプ説明

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

9.1.2. .status

説明
status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

9.1.3. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

9.1.4. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

9.1.5. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

9.1.6. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

9.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/csisnapshotcontrollers

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

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

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

9.2.1. /apis/operator.openshift.io/v1/csisnapshotcontrollers

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
CSISnapshotController のコレクションを削除します
Expand
表9.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表9.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 CSISnapshotController のオブジェクトをリスト表示します
Expand
表9.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表9.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotControllerList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表9.7 ボディーパラメーター
パラメーター説明

body

CSISnapshotController スキーマ

 
Expand
表9.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

201 - Created

CSISnapshotController スキーマ

202 - Accepted

CSISnapshotController スキーマ

401 - Unauthorized

空白

9.2.2. /apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}

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

name

string

CSISnapshotController の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表9.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された CSISnapshotController を読み取ります
Expand
表9.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表9.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表9.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表9.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表9.20 ボディーパラメーター
パラメーター説明

body

CSISnapshotController スキーマ

 
Expand
表9.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

201 - Created

CSISnapshotController スキーマ

401 - Unauthorized

空白

9.2.3. /apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}/status

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

name

string

CSISnapshotController の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された CSISnapshotController のステータスを読み取ります
Expand
表9.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表9.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表9.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表9.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表9.30 ボディーパラメーター
パラメーター説明

body

CSISnapshotController スキーマ

 
Expand
表9.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CSISnapshotController スキーマ

201 - Created

CSISnapshotController スキーマ

401 - Unauthorized

空白

第10章 DNS [operator.openshift.io/v1]

説明
DNS は CoreDNS コンポーネントを管理し、クラスター内の Pod およびサービスの名前解決サービスを提供します。これは、DNS ベースのサービス検出仕様 (https://github.com/kubernetes/dns/blob/master/docs/specification.md) をサポートしています。詳細: https://kubernetes.io/docs/tasks/administer-cluster/coredns 互換性レベル 1: メジャーリリース内で最低 12 カ月間、または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object

10.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

spec は、DNS の望ましい動作の仕様です。

status

object

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

10.1.1. .spec

説明
spec は、DNS の望ましい動作の仕様です。
object
Expand
プロパティータイプ説明

cache

object

cache は、Corefile にリストされているすべてのサーバーブロックに適用されるキャッシュ設定を表します。このフィールドでは、クラスター管理者が必要に応じて以下を設定できます。* positiveTTL: これは肯定応答をキャッシュする期間です。* negativeTTL: これは否定応答をキャッシュする期間です。これが設定されていない場合、OpenShift はデフォルト値を使用してポジティブキャッシュとネガティブキャッシュを設定します。デフォルト値は変更される可能性があります。執筆時点では、デフォルトの positiveTTL は 900 秒、デフォルトの negativeTTL は 30 秒です。または、お使いの OpenShift バージョンの Corefile に記載されているとおりです。

logLevel

string

logLevel は、CoreDNS に必要なログの詳細度を表します。次のいずれかの値を指定できます。* Normal: アップストリームリゾルバーからのエラーをログに記録します。* Debug: エラー、NXDOMAIN 応答、および NODATA 応答をログに記録します。* Trace: エラーとすべての応答をログに記録します。logLevel: Trace を設定すると、非常に詳細なログが生成されます。有効な値は、"Normal"、"Debug"、"Trace" です。Defaults to "Normal".

managementState

string

managementState は、DNS Operator がクラスター DNS を管理する必要があるかどうかを示します

nodePlacement

object

nodePlacement は、DNS Pod のスケジューリングを明示的に制御します。一般に、すべてのノードで DNS Pod を実行すると、ネットワークを介して別のノードの DNS Pod に移動するのではなく、常にローカル DNS Pod によって DNS クエリーが処理されるようになります。ただし、セキュリティーポリシーでは、DNS Pod の配置を特定のノードに制限する必要がある場合があります。たとえば、セキュリティーポリシーで、任意のノード上の Pod が API と通信することを禁止している場合、ノードセレクターを指定して、DNS Pod を API との通信が許可されているノードに制限できます。逆に、特定のテイントのあるノードで DNS Pod を実行する必要がある場合は、そのテイントに対して許容範囲を指定できます。設定されていない場合、デフォルトが使用されます。詳細は、nodePlacement を参照してください。

operatorLogLevel

string

operatorLogLevel は、DNS Operator のログレベルを制御します。有効な値は、"Normal"、"Debug"、"Trace" です。デフォルトは "Normal" です。operatorLogLevel: Trace を設定すると、非常に詳細なログが生成されます。

servers

array

servers は、クラスタードメインのスコープ外にある 1 つ以上のサブドメインに名前クエリーの委譲を提供する DNS リゾルバーのリストです。servers に複数のサーバーが含まれている場合は、最長後方一致を使用してサーバーが決定されます。たとえば、2 つのサーバーがあり、1 つは "foo.com" 用、もう 1 つは "a.foo.com" 用で、名前クエリーが "www.a.foo.com" 用である場合、そのクエリーはゾーンが "a.foo.com" のサーバーにルーティングされます。このフィールドが nil の場合、サーバーは作成されません。

servers[]

object

Server は、CoreDNS のインスタンスごとに実行されるサーバーのスキーマを定義します。

upstreamResolvers

object

upstreamResolvers は、デフォルト (".") サーバーの場合に、CoreDNS が DNS メッセージをアップストリームリゾルバーにプロキシーするように設定するためのスキーマを定義します。このフィールドが指定されていない場合、使用されるアップストリームはデフォルトで/etc/resolv.conf になり、ポリシーは "sequential" になります。

10.1.2. .spec.cache

説明
cache は、Corefile にリストされているすべてのサーバーブロックに適用されるキャッシュ設定を表します。このフィールドでは、クラスター管理者が必要に応じて以下を設定できます。* positiveTTL: これは肯定応答をキャッシュする期間です。* negativeTTL: これは否定応答をキャッシュする期間です。これが設定されていない場合、OpenShift はデフォルト値を使用してポジティブキャッシュとネガティブキャッシュを設定します。デフォルト値は変更される可能性があります。執筆時点では、デフォルトの positiveTTL は 900 秒、デフォルトの negativeTTL は 30 秒です。または、お使いの OpenShift バージョンの Corefile に記載されているとおりです。
object
Expand
プロパティータイプ説明

negativeTTL

string

negativeTTL は任意であり、否定応答をキャッシュする時間を指定します。設定する場合、1s (1 秒) 以上の値にする必要があります。理論上の最大値は数年です。このフィールドには、符号なしの 10 進数の期間文字列を指定する必要があります。それぞれの数字に少数 (任意) と単位の接尾辞を付けます。たとえば、"100s"、"1m30s"、"12h30m10s" です。秒の小数点以下の値は、最も近い秒に切り捨てられます。設定した値が 1 秒未満の場合、デフォルト値が使用されます。設定されていない場合、値は 0 秒になり、OpenShift の各バージョンの Corefile に特に記載がない限り、OpenShift はデフォルト値の 30 秒を使用します。デフォルト値の 30 秒は変更される可能性があります。

positiveTTL

string

positiveTTL は任意であり、肯定応答をキャッシュする時間を指定します。設定する場合、1s (1 秒) 以上の値にする必要があります。理論上の最大値は数年です。このフィールドには、符号なしの 10 進数の期間文字列を指定する必要があります。それぞれの数字に少数 (任意) と単位の接尾辞を付けます。たとえば、"100s"、"1m30s"、"12h30m10s" です。秒の小数点以下の値は、最も近い秒に切り捨てられます。設定した値が 1 秒未満の場合、デフォルト値が使用されます。設定されていない場合、値は 0 秒になり、OpenShift の各バージョンの Corefile に特に記載がない限り、OpenShift はデフォルト値の 900 秒を使用します。デフォルト値の 900 秒は変更される可能性があります。

10.1.3. .spec.nodePlacement

説明
nodePlacement は、DNS Pod のスケジューリングを明示的に制御します。一般に、すべてのノードで DNS Pod を実行すると、ネットワークを介して別のノードの DNS Pod に移動するのではなく、常にローカル DNS Pod によって DNS クエリーが処理されるようになります。ただし、セキュリティーポリシーでは、DNS Pod の配置を特定のノードに制限する必要がある場合があります。たとえば、セキュリティーポリシーで、任意のノード上の Pod が API と通信することを禁止している場合、ノードセレクターを指定して、DNS Pod を API との通信が許可されているノードに制限できます。逆に、特定のテイントのあるノードで DNS Pod を実行する必要がある場合は、そのテイントに対して許容範囲を指定できます。設定されていない場合、デフォルトが使用されます。詳細は、nodePlacement を参照してください。
object
Expand
プロパティータイプ説明

nodeSelector

object (string)

nodeSelector は、DNS Pod に適用されるノードセレクターです。空の場合、デフォルトが使用されます。現在は次のとおりです。kubernetes.io/os:linux このデフォルトは変更される可能性があります。設定されている場合、指定されたセレクターが使用され、デフォルトが置き換えられます。

tolerations

array

tolerations は、DNS Pod に適用される許容範囲のリストです。空の場合、DNS Operator は "node-role.kubernetes.io/master" taint の許容範囲を設定します。このデフォルトは変更される可能性があります。"node-role.kubernetes.io/master" テイントの許容値を含めずに許容値を指定すると、すべてのワーカーノードが使用できなくなった場合に停止につながる可能性があるため、リスクが伴う可能性があります。デーモンコントローラーにもいくつかの許容値が追加されていることに注意してください。https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ を参照してください

tolerations[]

object

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

10.1.4. .spec.nodePlacement.tolerations

説明
tolerations は、DNS Pod に適用される許容範囲のリストです。空の場合、DNS Operator は "node-role.kubernetes.io/master" taint の許容範囲を設定します。このデフォルトは変更される可能性があります。"node-role.kubernetes.io/master" テイントの許容値を含めずに許容値を指定すると、すべてのワーカーノードが使用できなくなった場合に停止につながる可能性があるため、リスクが伴う可能性があります。デーモンコントローラーにもいくつかの許容値が追加されていることに注意してください。https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ を参照してください
array

10.1.5. .spec.nodePlacement.tolerations[]

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

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

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

10.1.6. .spec.servers

説明
servers は、クラスタードメインのスコープ外にある 1 つ以上のサブドメインに名前クエリーの委譲を提供する DNS リゾルバーのリストです。servers に複数のサーバーが含まれている場合は、最長後方一致を使用してサーバーが決定されます。たとえば、2 つのサーバーがあり、1 つは "foo.com" 用、もう 1 つは "a.foo.com" 用で、名前クエリーが "www.a.foo.com" 用である場合、そのクエリーはゾーンが "a.foo.com" のサーバーにルーティングされます。このフィールドが nil の場合、サーバーは作成されません。
array

10.1.7. .spec.servers[]

説明
Server は、CoreDNS のインスタンスごとに実行されるサーバーのスキーマを定義します。
object
Expand
プロパティータイプ説明

forwardPlugin

object

forwardPlugin は、DNS メッセージをアップストリームリゾルバーにプロキシーするように CoreDNS を設定するためのスキーマを定義します。

name

string

name は必須であり、サーバーの一意の名前を指定します。名前は、rfc6335 のサービス名構文に準拠している必要があります。

zones

array (string)

zones は必須であり、サーバーが権限を持つサブドメインを指定します。ゾーンは、サブドメインの rfc1123 定義に準拠している必要があります。クラスタードメイン (つまり、"cluster.local") の指定は無効です。

10.1.8. .spec.servers[].forwardPlugin

説明
forwardPlugin は、DNS メッセージをアップストリームリゾルバーにプロキシーするように CoreDNS を設定するためのスキーマを定義します。
object
Expand
プロパティータイプ説明

policy

string

policy は、アップストリームサーバーをクエリーのために選択する順序を決定するために使用します。次のいずれかの値を指定できます。* "Random": クエリーごとにランダムなアップストリームサーバーを選択します。* "RoundRobin": ラウンドロビンの順序でアップストリームサーバーを選択し、新しいクエリーごとに次のサーバーに移動します。* "Sequential": 新しいクエリーごとに最初のサーバーから始めて、応答が得られるまでアップストリームサーバーに順番にクエリーを試行します。デフォルト値は "Random" です。

protocolStrategy

string

protocolStrategy は、アップストリーム DNS リクエストに使用するプロトコルを指定します。protocolStrategy の有効な値は "TCP" です (省略可能)。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトでは、元のクライアントリクエストのプロトコルが使用されます。"TCP" に設定すると、クライアントリクエストが UDP を使用する場合でも、すべてのアップストリーム DNS リクエストに対して TCP が必ず使用されます。"TCP" は、非準拠のアップストリームリゾルバーなどによって発生する UDP 固有の問題には役立ちます。ただし、消費される帯域幅が増加したり、DNS 応答時間が長くなったりする可能性があります。protocolStrategy は、CoreDNS がアップストリームリゾルバーに対して行う DNS リクエストのプロトコルにのみ影響することに注意してください。クライアントと CoreDNS 間の DNS リクエストのプロトコルには影響しません。

transportConfig

object

transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。

upstreams

array (string)

upstreams は、ゾーンのサブドメインの名前クエリーを転送するリゾルバーのリストです。CoreDNS の各インスタンスは、アップストリームのヘルスチェックを実行します。正常なアップストリームが交換中にエラーを返すと、アップストリームの別のリゾルバーが試行されます。アップストリームは、ポリシーで指定された順序で選択されます。各アップストリームは、アップストリームが 53 以外のポートでリッスンしている場合、IP アドレスまたは IP: ポートで表されます。ForwardPlugin ごとに最大 15 個のアップストリームが許可されます。

10.1.9. .spec.servers[].forwardPlugin.transportConfig

説明
transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。
object
Expand
プロパティータイプ説明

tls

object

tls には、トランスポートが "TLS" に設定されているときに使用する追加の設定オプションを含めます。

transport

string

transport を使用すると、クラスター管理者はクラスターの DNS とアップストリームリゾルバー間の DNS-over-TLS 接続の使用を選択できます。CABundle を設定せずにこのレベルで TLS をトランスポートとして設定すると、システム証明書がアップストリームリゾルバーのサービス証明書の検証に使用されます。可能な値: "" (空) - 明示的な指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトは "Cleartext" です。"Cleartext" - クラスター管理者が指定するクリアテキストオプション。この値を指定しても、得られる機能は空の値と同じですが、クラスター管理者がトランスポートについてより明示的に指定する場合や、"TLS" から "Cleartext" に明示的に切り替える場合に役立つことがあります。"TLS" - DNS クエリーを TLS 接続経由で送信する必要があることを示します。トランスポートを TLS に設定した場合、ServerName も設定する必要があります。アップストリーム IP にポートが含まれていない場合、RFC 7858 セクション 3.1 (https://datatracker.ietf.org/doc/html/rfc7858#section-3.1) に従って、デフォルトでポート 853 が試行されます。

10.1.10. .spec.servers[].forwardPlugin.transportConfig.tls

説明
tls には、トランスポートが "TLS" に設定されているときに使用する追加の設定オプションを含めます。
object
必須
  • serverName
Expand
プロパティータイプ説明

caBundle

object

caBundle は、1 つの CA 証明書か CA バンドルを含んでいる必要がある ConfigMap を参照します。これを使用すると、クラスター管理者は、アップストリームリゾルバーの証明書を検証するための独自の CA または CA バンドルを指定できます。1. configmap には ca-bundle.crt キーが含まれている必要があります。2. 値は PEM でエンコードされた CA 証明書または CA バンドルである必要があります。3. 管理者は、openshift-config namespace にこの configmap を作成する必要があります。4. アップストリームサーバー証明書には、ServerName と一致するサブジェクト代替名 (SAN) が含まれている必要があります。

serverName

string

serverName は、DNS クエリーを転送するときに接続するアップストリームサーバーです。これは、トランスポートが "TLS" に設定されている場合に必要です。ServerName は、RFC 1123 の DNS 命名規則に基づいて検証され、アップストリームリゾルバーにインストールされている TLS 証明書と一致する必要があります。

10.1.11. .spec.servers[].forwardPlugin.transportConfig.tls.caBundle

説明
caBundle は、1 つの CA 証明書か CA バンドルを含んでいる必要がある ConfigMap を参照します。これを使用すると、クラスター管理者は、アップストリームリゾルバーの証明書を検証するための独自の CA または CA バンドルを指定できます。1. configmap には ca-bundle.crt キーが含まれている必要があります。2. 値は PEM でエンコードされた CA 証明書または CA バンドルである必要があります。3. 管理者は、openshift-config namespace にこの configmap を作成する必要があります。4. アップストリームサーバー証明書には、ServerName と一致するサブジェクト代替名 (SAN) が含まれている必要があります。
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される config map の metadata.name です

10.1.12. .spec.upstreamResolvers

説明
upstreamResolvers は、デフォルト (".") サーバーの場合に、CoreDNS が DNS メッセージをアップストリームリゾルバーにプロキシーするように設定するためのスキーマを定義します。このフィールドが指定されていない場合、使用されるアップストリームはデフォルトで/etc/resolv.conf になり、ポリシーは "sequential" になります。
object
Expand
プロパティータイプ説明

policy

string

Policy は、アップストリームサーバーをクエリーのために選択する順序を決定するために使用します。次のいずれかの値を指定できます。* "Random": クエリーごとにランダムなアップストリームサーバーを選択します。* "RoundRobin": ラウンドロビンの順序でアップストリームサーバーを選択し、新しいクエリーごとに次のサーバーに移動します。* "Sequential": 新しいクエリーごとに最初のサーバーから始めて、応答が得られるまでアップストリームサーバーに順番にクエリーを試行します。デフォルト値は "Sequential" です。

protocolStrategy

string

protocolStrategy は、アップストリーム DNS リクエストに使用するプロトコルを指定します。protocolStrategy の有効な値は "TCP" です (省略可能)。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトでは、元のクライアントリクエストのプロトコルが使用されます。"TCP" に設定すると、クライアントリクエストが UDP を使用する場合でも、すべてのアップストリーム DNS リクエストに対して TCP が必ず使用されます。"TCP" は、非準拠のアップストリームリゾルバーなどによって発生する UDP 固有の問題には役立ちます。ただし、消費される帯域幅が増加したり、DNS 応答時間が長くなったりする可能性があります。protocolStrategy は、CoreDNS がアップストリームリゾルバーに対して行う DNS リクエストのプロトコルにのみ影響することに注意してください。クライアントと CoreDNS 間の DNS リクエストのプロトコルには影響しません。

transportConfig

object

transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。

upstreams

array

Upstreams は、"."ドメインの名前クエリーを転送するリゾルバーのリストです。CoreDNS の各インスタンスは、アップストリームのヘルスチェックを実行します。正常なアップストリームが交換中にエラーを返すと、アップストリームの別のリゾルバーが試行されます。アップストリームは、ポリシーで指定された順序で選択されます。ForwardPlugin ごとに最大 15 個のアップストリームが許可されます。アップストリームが指定されていない場合は、デフォルトで /etc/resolv.conf が使用されます。

upstreams[]

object

upstream のタイプは、SystemResolvConf タイプ、または Network タイプのいずれかになります。* SystemResolvConf タイプの Upstream の場合、追加のフィールドは必要ありません:アップストリームは /etc/resolv.conf を使用するよう設定されます。*Network タイプの Upstream の場合は、アップストリームが 53 以外のポートでリッスンしている場合は、NetworkResolver フィールドを IP アドレスまたは IP:port で定義する必要があります。

10.1.13. .spec.upstreamResolvers.transportConfig

説明
transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。
object
Expand
プロパティータイプ説明

tls

object

tls には、トランスポートが "TLS" に設定されているときに使用する追加の設定オプションを含めます。

transport

string

transport を使用すると、クラスター管理者はクラスターの DNS とアップストリームリゾルバー間の DNS-over-TLS 接続の使用を選択できます。CABundle を設定せずにこのレベルで TLS をトランスポートとして設定すると、システム証明書がアップストリームリゾルバーのサービス証明書の検証に使用されます。可能な値: "" (空) - 明示的な指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトは "Cleartext" です。"Cleartext" - クラスター管理者が指定するクリアテキストオプション。この値を指定しても、得られる機能は空の値と同じですが、クラスター管理者がトランスポートについてより明示的に指定する場合や、"TLS" から "Cleartext" に明示的に切り替える場合に役立つことがあります。"TLS" - DNS クエリーを TLS 接続経由で送信する必要があることを示します。トランスポートを TLS に設定した場合、ServerName も設定する必要があります。アップストリーム IP にポートが含まれていない場合、RFC 7858 セクション 3.1 (https://datatracker.ietf.org/doc/html/rfc7858#section-3.1) に従って、デフォルトでポート 853 が試行されます。

10.1.14. .spec.upstreamResolvers.transportConfig.tls

説明
tls には、トランスポートが "TLS" に設定されているときに使用する追加の設定オプションを含めます。
object
必須
  • serverName
Expand
プロパティータイプ説明

caBundle

object

caBundle は、1 つの CA 証明書か CA バンドルを含んでいる必要がある ConfigMap を参照します。これを使用すると、クラスター管理者は、アップストリームリゾルバーの証明書を検証するための独自の CA または CA バンドルを指定できます。1. configmap には ca-bundle.crt キーが含まれている必要があります。2. 値は PEM でエンコードされた CA 証明書または CA バンドルである必要があります。3. 管理者は、openshift-config namespace にこの configmap を作成する必要があります。4. アップストリームサーバー証明書には、ServerName と一致するサブジェクト代替名 (SAN) が含まれている必要があります。

serverName

string

serverName は、DNS クエリーを転送するときに接続するアップストリームサーバーです。これは、トランスポートが "TLS" に設定されている場合に必要です。ServerName は、RFC 1123 の DNS 命名規則に基づいて検証され、アップストリームリゾルバーにインストールされている TLS 証明書と一致する必要があります。

10.1.15. .spec.upstreamResolvers.transportConfig.tls.caBundle

説明
caBundle は、1 つの CA 証明書か CA バンドルを含んでいる必要がある ConfigMap を参照します。これを使用すると、クラスター管理者は、アップストリームリゾルバーの証明書を検証するための独自の CA または CA バンドルを指定できます。1. configmap には ca-bundle.crt キーが含まれている必要があります。2. 値は PEM でエンコードされた CA 証明書または CA バンドルである必要があります。3. 管理者は、openshift-config namespace にこの configmap を作成する必要があります。4. アップストリームサーバー証明書には、ServerName と一致するサブジェクト代替名 (SAN) が含まれている必要があります。
object
必須
  • name
Expand
プロパティータイプ説明

name

string

name は、参照される config map の metadata.name です

10.1.16. .spec.upstreamResolvers.upstreams

説明
Upstreams は、"."ドメインの名前クエリーを転送するリゾルバーのリストです。CoreDNS の各インスタンスは、アップストリームのヘルスチェックを実行します。正常なアップストリームが交換中にエラーを返すと、アップストリームの別のリゾルバーが試行されます。アップストリームは、ポリシーで指定された順序で選択されます。ForwardPlugin ごとに最大 15 個のアップストリームが許可されます。アップストリームが指定されていない場合は、デフォルトで /etc/resolv.conf が使用されます。
array

10.1.17. .spec.upstreamResolvers.upstreams[]

説明
upstream のタイプは、SystemResolvConf タイプ、または Network タイプのいずれかになります。* SystemResolvConf タイプの Upstream の場合、追加のフィールドは必要ありません:アップストリームは /etc/resolv.conf を使用するよう設定されます。*Network タイプの Upstream の場合は、アップストリームが 53 以外のポートでリッスンしている場合は、NetworkResolver フィールドを IP アドレスまたは IP:port で定義する必要があります。
object
必須
  • type
Expand
プロパティータイプ説明

address

string

Address は、Type が Network に設定されている場合に定義する必要があります。それ以外の場合は無視されます。有効な IPv4 または IPv6 アドレスである必要があります。

port

integer

Port は、Type が Network に設定されている場合に定義する必要があります。それ以外の場合は無視されます。ポートは 65535 までである必要があります。

type

string

Type は、このアップストリームに IP/IP:port リゾルバーを含めるか、ローカルの /etc/resolv.conf を含めるかを定義します。Type には、2 つの値 (SystemResolvConf または Network) を指定できます。* SystemResolvConf を使用する場合、アップストリーム構造に追加のフィールドを定義する必要はありません。/etc/resolv.conf が使用されます。* Network を使用する場合、アップストリーム構造に少なくともアドレスが含まれている必要があります。

10.1.18. .status

説明
status は、DNS の最後に観察されたステータスです。
object
必須
  • clusterDomain
  • clusterIP
Expand
プロパティータイプ説明

clusterDomain

string

clusterDomain は、DNS サービスのローカルクラスター DNS ドメイン接尾辞です。これは、RFC 1034 のセクション 3.5 (https://tools.ietf.org/html/rfc1034#section-3.5) で定義されているサブドメインです。たとえば、"cluster.local" です。詳細: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service

clusterIP

string

clusterIP は、この DNS を利用できるようにするためのサービス IP です。デフォルトの DNS の場合、これは、デフォルトの ClusterFirst DNS ポリシーを使用している Pod のデフォルトのネームサーバーとして使用されている既知の IP です。一般に、この IP は、Pod の spec.dnsConfig.nameservers リストで指定するか、クラスター内から名前解決を実行するときに明示的に使用できます。例: dig foo.com @<service IP> 詳細: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

conditions

array

条件は、クラスター上の DNS の状態に関する情報を提供します。サポートされている DNS 条件は次のとおりです。*使用可能 - 次の条件が満たされた場合に真になります。*DNS コントローラーデーモンセットが使用可能です。- これらの条件のいずれかが満たされていない場合は False。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

10.1.19. .status.conditions

説明
条件は、クラスター上の DNS の状態に関する情報を提供します。サポートされている DNS 条件は次のとおりです。*使用可能 - 次の条件が満たされた場合に真になります。*DNS コントローラーデーモンセットが使用可能です。- これらの条件のいずれかが満たされていない場合は False。
array

10.1.20. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

10.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/dnses

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

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

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

10.2.1. /apis/operator.openshift.io/v1/dnses

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表10.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
DNS の種類のオブジェクトをリスト表示します
Expand
表10.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表10.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
DNS を作成する
Expand
表10.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表10.7 ボディーパラメーター
パラメーター説明

body

DNS スキーマ

 
Expand
表10.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

201 - Created

DNS スキーマ

202 - Accepted

DNS スキーマ

401 - Unauthorized

空白

10.2.2. /apis/operator.openshift.io/v1/dnses/{name}

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

name

string

DNS の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
DNS を削除する
Expand
表10.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表10.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された DNS を読み取る
Expand
表10.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表10.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表10.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表10.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表10.20 ボディーパラメーター
パラメーター説明

body

DNS スキーマ

 
Expand
表10.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

201 - Created

DNS スキーマ

401 - Unauthorized

空白

10.2.3. /apis/operator.openshift.io/v1/dnses/{name}/status

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

name

string

DNS の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された DNS のステータスを読み取る
Expand
表10.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表10.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表10.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表10.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表10.30 ボディーパラメーター
パラメーター説明

body

DNS スキーマ

 
Expand
表10.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNS スキーマ

201 - Created

DNS スキーマ

401 - Unauthorized

空白

第11章 DNSRecord [ingress.operator.openshift.io/v1]

説明
DNSRecord は、dns.config.openshift.io/cluster.spec.publicZone および.spec.privateZone によって定義されたゾーンで管理される DNS レコードです。このリソースのクラスター管理操作はサポートされていません。このリソースは、OpenShift Operator の内部通信専用です。DNSManagementPolicy が "Unmanaged" の場合、Operator はクラウドプロバイダー上の DNS レコードの管理を担当しません。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object

11.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

spec は、dnsRecord の望ましい動作の仕様です。

status

object

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

11.1.1. .spec

説明
spec は、dnsRecord の望ましい動作の仕様です。
object
必須
  • dnsManagementPolicy
  • dnsName
  • recordTTL
  • recordType
  • targets
Expand
プロパティータイプ説明

dnsManagementPolicy

string

dnsManagementPolicy は、DNS レコードに適用されている現在のポリシーを示します。ポリシーが "Unmanaged" に設定されているレコードは、Ingress Operator によって無視されます。この場合、クラウドプロバイダー上の DNS レコードは、Operator によって管理されません。外部で管理されるため、"Published" ステータス状態が "Unknown" ステータスに更新されます。クラウドプロバイダー上の既存のレコードは、クラスター管理者の判断で削除できます。このフィールドのデフォルトは Managed です。有効な値は "Managed" と "Unmanaged" です。

dnsName

string

dnsName は、DNS レコードのホスト名です

recordTTL

integer

recordTTL は、秒単位のレコード TTL です。ゼロの場合、デフォルトは 30 です。RecordTTL は、AWS リージョンのエイリアスターゲットでは使用されませんが、AWS API コントラクトに従って、CNAME ターゲットで使用されます。

recordType

string

recordType は DNS レコードタイプです。たとえば、"A" または "CNAME"。

targets

array (string)

ターゲットはレコードターゲットです。

11.1.2. .status

説明
status は、dnsRecord の最後に観察されたステータスです。
object
Expand
プロパティータイプ説明

observedGeneration

integer

observedGeneration は、最近観察された DNSRecord の世代です。DNSRecord が更新されると、コントローラーは各マネージドゾーンの対応するレコードを更新します。特定のゾーンの更新が失敗した場合、その失敗はゾーンのステータス条件に記録されるため、コントローラーはその特定のゾーンの更新を再試行する必要があると判断できます。

zones

array

ゾーンは、各ゾーンのレコードのステータスです。

zones[]

object

DNSZoneStatus は、特定のゾーン内のレコードのステータスです。

11.1.3. .status.zones

説明
ゾーンは、各ゾーンのレコードのステータスです。
array

11.1.4. .status.zones[]

説明
DNSZoneStatus は、特定のゾーン内のレコードのステータスです。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、ゾーン内のレコードに関連する状態です。レコードの公開が成功すると、"Published" 状態のステータスが "True" に設定されます。失敗すると、"False" に設定され、失敗の原因を説明する理由とメッセージが提供されます。

conditions[]

object

DNSZoneCondition は、単なる標準の条件フィールドです。

dnsZone

object

dnsZone は、レコードが公開されるゾーンです。

11.1.5. .status.zones[].conditions

説明
conditions は、ゾーン内のレコードに関連する状態です。レコードの公開が成功すると、"Published" 状態のステータスが "True" に設定されます。失敗すると、"False" に設定され、失敗の原因を説明する理由とメッセージが提供されます。
array

11.1.6. .status.zones[].conditions[]

説明
DNSZoneCondition は、単なる標準の条件フィールドです。
object
必須
  • status
  • type
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

11.1.7. .status.zones[].dnsZone

説明
dnsZone は、レコードが公開されるゾーンです。
object
Expand
プロパティータイプ説明

id

string

AWS では [1] で ID を id としてゾーンを取得でき、Azure では [2] で ID をあらかじめ決められた名前として取得でき、GCP では [3] で ID をあらかじめ決められた名前としてゾーンを取得できるようになっています。[1]: https://docs.aws.amazon.com/cli/latest/reference/route53/get-hosted-zone.html#options [2]: https://docs.microsoft.com/en-us/cli/azure/network/dns/zone?view=azure-cli-latest#az-network-dns-zone-show [3]: https://cloud.google.com/dns/docs/reference/v1/managedZones/get

tags

object (string)

タグを使用して DNS ホストゾーンを照会することができます。AWS では、resourcegroupstaggingapi [1] を使用して、Tags タグフィルターとして使用してゾーンを取得できます [1]: https://docs.aws.amazon.com/cli/latest/reference/resourcegroupstaggingapi/get-resources.html#options

11.2. API エンドポイント

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

  • /apis/ingress.operator.openshift.io/v1/dnsrecords

    • GET: 種類が DNSRecord のオブジェクトをリスト表示します。
  • /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords

    • DELETE: DNSRecord のコレクションを削除します。
    • GET: 種類が DNSRecord のオブジェクトをリスト表示します。
    • POST: DNSRecord を作成します。
  • /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}

    • DELETE: DNSRecord を削除します。
    • GET: 指定された DNSRecord を読み取ります。
    • PATCH: 指定された DNSRecord を部分的に更新します。
    • PUT: 指定された DNSRecord を置き換えます。
  • /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}/status

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

11.2.1. /apis/ingress.operator.openshift.io/v1/dnsrecords

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

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

HTTP メソッド
GET
説明
種類が DNSRecord のオブジェクトをリスト表示します。
Expand
表11.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecordList スキーマ

401 - Unauthorized

空白

11.2.2. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords

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

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
DNSRecord のコレクションを削除します
Expand
表11.5 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表11.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
DNSRecord の種類のオブジェクトをリスト表示します
Expand
表11.7 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表11.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecordList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
DNSRecord を作成する
Expand
表11.9 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表11.10 ボディーパラメーター
パラメーター説明

body

DNSRecord スキーマ

 
Expand
表11.11 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

201 - Created

DNSRecord スキーマ

202 - Accepted

DNSRecord スキーマ

401 - Unauthorized

空白

11.2.3. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}

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

name

string

DNSRecord の名前

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表11.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された DNSRecord を読み取ります
Expand
表11.17 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表11.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表11.20 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表11.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表11.23 ボディーパラメーター
パラメーター説明

body

DNSRecord スキーマ

 
Expand
表11.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

201 - Created

DNSRecord スキーマ

401 - Unauthorized

空白

11.2.4. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}/status

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

name

string

DNSRecord の名前

namespace

string

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

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された DNSRecord のステータスを読み取ります
Expand
表11.27 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表11.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表11.30 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表11.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表11.33 ボディーパラメーター
パラメーター説明

body

DNSRecord スキーマ

 
Expand
表11.34 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

DNSRecord スキーマ

201 - Created

DNSRecord スキーマ

401 - Unauthorized

空白

第12章 Etcd [operator.openshift.io/v1]

説明
Etcd は、etcd を管理するように Operator を設定するための情報を提供します。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • spec

12.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

 

status

object

 

12.1.1. .spec

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

failedRevisionLimit

integer

failedRevisionLimit は、ディスク上に保持するために失敗した静的 Pod インストーラーリビジョンの数であり、API では -1 =無制限、0 または未設定= 5(デフォルト)

forceRedeploymentReason

string

forceRedeploymentReason を使用すると、一意の文字列を指定して、オペランドの再デプロイを強制できます。これにより、以前に失敗したデプロイメントを開始するメカニズムが提供され、同じ設定で再度失敗するのではなく、今回は機能すると思われる理由が提供されます。

logLevel

string

logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

managementState

string

managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します

observedConfig

``

observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します

operatorLogLevel

string

operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

succeededRevisionLimit

integer

successedRevisionLimit は、ディスク上に保持する成功した静的 Pod インストーラーリビジョンの数であり、API では -1 =無制限、0 または未設定= 5(デフォルト)

unsupportedConfigOverrides

``

unsupportedConfigOverrides は、以前に設定されたオプションをオーバーライドするスパース設定を保持します。オーバーライドするフィールドである必要があるだけで、次の順序でオーバーレイされます。1.ハードコードされたデフォルト 2.observedConfig 3. unsupportedConfigOverrides

12.1.2. .status

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

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

generations

array

generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。

generations[]

object

GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。

latestAvailableRevision

integer

latestAvailableRevision は、最新のデプロイメントの deploymentID です。

latestAvailableRevisionReason

string

latestAvailableRevisionReason は、最新のデプロイメントの詳細な理由を説明します

nodeStatuses

array

nodeStatuses は、個々のノード全体のデプロイメント値とエラーを追跡します

nodeStatuses[]

object

NodeStatus は、この Operator によって管理される特定のノードの現在の状態に関する情報を提供します。

observedGeneration

integer

observedGeneration はあなたが扱った最後の世代の変更です

readyReplicas

integer

readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します

version

string

バージョンは、この可用性が適用されるレベルです

12.1.3. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

12.1.4. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

12.1.5. .status.generations

説明
generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
array

12.1.6. .status.generations[]

説明
GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
object
Expand
プロパティータイプ説明

group

string

group は追跡対象のグループです。

hash

string

hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。

lastGeneration

integer

lastGeneration は関連するワークロードコントローラーの最後の生成です。

name

string

name は追跡対象の名前です。

namespace

string

namespace は追跡対象の場所です。

resource

string

resource は追跡対象のリソースタイプです。

12.1.7. .status.nodeStatuses

説明
nodeStatuses は、個々のノード全体のデプロイメント値とエラーを追跡します
array

12.1.8. .status.nodeStatuses[]

説明
NodeStatus は、この Operator によって管理される特定のノードの現在の状態に関する情報を提供します。
object
Expand
プロパティータイプ説明

currentRevision

integer

currentRevision は、最近成功したデプロイメントの生成です

lastFailedCount

integer

lastFailedCount は、最後に失敗したリビジョンのインストーラー Pod が失敗した頻度です。

lastFailedReason

string

lastFailedReason は、機械で読み取り可能な障害理由文字列です。

lastFailedRevision

integer

lastFailedRevision は、デプロイを試みて失敗したデプロイメントの世代です。

lastFailedRevisionErrors

array (string)

lastFailedRevisionErrors は、lastFailedRevision で参照されているデプロイメントの失敗時に人間が読み取れるエラーのリストです。

lastFailedTime

string

lastFailedTime は、最後に失敗したリビジョンが最後に失敗した時刻です。

lastFallbackCount

integer

lastFallbackCount は、前のリビジョンへのフォールバックが発生した頻度です。

nodeName

string

nodeName はノードの名前です

targetRevision

integer

targetRevision は、適用しようとしているデプロイメントの世代です

12.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1/etcds

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

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

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

12.2.1. /apis/operator.openshift.io/v1/etcds

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表12.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類 Etcd のオブジェクトをリスト表示します
Expand
表12.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表12.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

EtcdList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
Etcd を作成する
Expand
表12.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表12.7 ボディーパラメーター
パラメーター説明

body

Etcd スキーマ

 
Expand
表12.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

201 - Created

Etcd スキーマ

202 - Accepted

Etcd スキーマ

401 - Unauthorized

空白

12.2.2. /apis/operator.openshift.io/v1/etcds/{name}

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

name

string

Etcd の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
Etcd を削除する
Expand
表12.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表12.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Etcd を読む
Expand
表12.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表12.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表12.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表12.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Etcd を交換してください
Expand
表12.19 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表12.20 ボディーパラメーター
パラメーター説明

body

Etcd スキーマ

 
Expand
表12.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

201 - Created

Etcd スキーマ

401 - Unauthorized

空白

12.2.3. /apis/operator.openshift.io/v1/etcds/{name}/status

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

name

string

Etcd の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された Etcd のステータスを読み取ります
Expand
表12.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表12.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表12.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表12.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表12.30 ボディーパラメーター
パラメーター説明

body

Etcd スキーマ

 
Expand
表12.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Etcd スキーマ

201 - Created

Etcd スキーマ

401 - Unauthorized

空白

第13章 ImageContentSourcePolicy [operator.openshift.io/v1alpha1]

説明
ImageContentSourcePolicy は、レジストリーミラールールの処理方法に関するクラスター全体の情報を保持します。複数のポリシーが定義されている場合、動作の結果は各フィールドで定義されます。互換性レベル 4: 互換性は提供されていません。API は、理由を問わずいつでも変更できます。これらの機能は、長期サポートを必要とするアプリケーションで使用することはできません。
object
必須
  • spec

13.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

spec は、ユーザーが設定可能な設定値を保持します。

13.1.1. .spec

説明
spec は、ユーザーが設定可能な設定値を保持します。
object
Expand
プロパティータイプ説明

repositoryDigestMirrors

array

repositoryDigestMirrors を使用すると、Pod 内のイメージダイジェストによって参照されるイメージを、ミラーリングされた代替のリポジトリーの場所から取得できます。Pod に提供されるイメージプル仕様は、RepositoryDigestMirrors で説明されているソースの場所と比較され、管理者が潜在的に高速なミラーを選択できるように、指定されたリポジトリーではなく、リスト内の任意のミラーからイメージをプルダウンできます。イメージダイジェストを持つイメージプル仕様にのみ、この動作が適用されます。タグは、プル仕様で指定されたリポジトリーから引き続きプルされます。各 “ソース” リポジトリーは独立して扱われます。異なる “ソース” リポジトリーの設定は相互作用しません。同じ “ソース” リポジトリーに対して複数のポリシーが定義されている場合、定義されたミラーのセットは一緒にマージされ、可能であればミラーの相対的な順序が維持されます。たとえば、ポリシー A にミラー a、b、c があり、ポリシー B にミラー c、d、e がある場合、ミラーは a、b、c、d、e の順序で使用されます。ミラーエントリーの順序が競合する場合 (たとえば a, bb, a) 設定は拒否されませんが、結果の順序は指定されていません。

repositoryDigestMirrors[]

object

RepositoryDigestMirrors は、レジストリー設定で mirros を処理する方法に関するクラスター全体の情報を保持します。注: ミラーは、ダイジェストによって参照されるイメージをプルする場合にのみ機能します。

13.1.2. .spec.repositoryDigestMirrors

説明
repositoryDigestMirrors を使用すると、Pod 内のイメージダイジェストによって参照されるイメージを、ミラーリングされた代替のリポジトリーの場所から取得できます。Pod に提供されるイメージプル仕様は、RepositoryDigestMirrors で説明されているソースの場所と比較され、管理者が潜在的に高速なミラーを選択できるように、指定されたリポジトリーではなく、リスト内の任意のミラーからイメージをプルダウンできます。イメージダイジェストを持つイメージプル仕様にのみ、この動作が適用されます。タグは、プル仕様で指定されたリポジトリーから引き続きプルされます。各 “ソース” リポジトリーは独立して扱われます。異なる “ソース” リポジトリーの設定は相互作用しません。同じ “ソース” リポジトリーに対して複数のポリシーが定義されている場合、定義されたミラーのセットは一緒にマージされ、可能であればミラーの相対的な順序が維持されます。たとえば、ポリシー A にミラー a、b、c があり、ポリシー B にミラー c、d、e がある場合、ミラーは a、b、c、d、e の順序で使用されます。ミラーエントリーの順序が競合する場合 (たとえば a, bb, a) 設定は拒否されませんが、結果の順序は指定されていません。
array

13.1.3. .spec.repositoryDigestMirrors[]

説明
RepositoryDigestMirrors は、レジストリー設定で mirros を処理する方法に関するクラスター全体の情報を保持します。注: ミラーは、ダイジェストによって参照されるイメージをプルする場合にのみ機能します。
object
必須
  • source
Expand
プロパティータイプ説明

mirrors

array (string)

同じイメージが含まれる可能性のあるリポジトリーを 1 つ以上指定します。このリスト内のミラーの順序はユーザーの希望する優先度として扱われますが、ソースはデフォルトですべてのミラーよりも低い優先度と見なされます。他の repositoryDigestMirrors オブジェクトを含む (ただしこれらに限定されない) 他のクラスター設定は、ミラーが接続される正確な順序に影響を与える可能性があります。

source

string

source は、たとえばイメージプル仕様でユーザーが参照するリポジトリーです。

13.2. API エンドポイント

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

  • /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies

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

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

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

13.2.1. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ImageContentSourcePolicy のコレクションを削除します
Expand
表13.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表13.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する ImageContentSourcePolicy
Expand
表13.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

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

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表13.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicyList スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表13.7 ボディーパラメーター
パラメーター説明

body

ImageContentSourcePolicy スキーマ

 
Expand
表13.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

201 - Created

ImageContentSourcePolicy スキーマ

202 - Accepted

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

13.2.2. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}

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

name

string

ImageContentSourcePolicy の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

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

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions スキーマ

 
Expand
表13.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ImageContentSourcePolicy を読み取ります
Expand
表13.14 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表13.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表13.17 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表13.18 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表13.20 ボディーパラメーター
パラメーター説明

body

ImageContentSourcePolicy スキーマ

 
Expand
表13.21 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

201 - Created

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

13.2.3. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}/status

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

name

string

ImageContentSourcePolicy の名前

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

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
GET
説明
指定された ImageContentSourcePolicy のステータスを読み取ります
Expand
表13.24 クエリーパラメーター
パラメーター説明

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

Expand
表13.25 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表13.27 ボディーパラメーター
パラメーター説明

body

Patch スキーマ

 
Expand
表13.28 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

fieldValidation

string

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

Expand
表13.30 ボディーパラメーター
パラメーター説明

body

ImageContentSourcePolicy スキーマ

 
Expand
表13.31 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImageContentSourcePolicy スキーマ

201 - Created

ImageContentSourcePolicy スキーマ

401 - Unauthorized

空白

第14章 ImagePruner [imageregistry.operator.openshift.io/v1]

説明
ImagePruner は、レジストリー Operator によって管理されるイメージレジストリープルーナーの設定オブジェクトです。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
object
必須
  • metadata
  • spec

14.1. 仕様

Expand
プロパティータイプ説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

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

spec

object

ImagePrunerSpec は、実行中のイメージ剪定ばさみの仕様を定義します。

status

object

ImagePrunerStatus は、イメージプルーナーの動作ステータスを報告します。

14.1.1. .spec

説明
ImagePrunerSpec は、実行中のイメージ剪定ばさみの仕様を定義します。
object
Expand
プロパティータイプ説明

affinity

object

アフィニティーは、イメージ剪定ばさみ Pod のノードアフィニティースケジューリングルールのグループです。

failedJobsHistoryLimit

integer

failedJobsHistoryLimit は、保持する失敗したイメージプルーナージョブの数を指定します。設定されていない場合は、デフォルトで 3 に設定されます。

ignoreInvalidImageReferences

boolean

ignoreInvalidImageReferences は、イメージ参照の解析中にプルーナーがエラーを無視できるかどうかを示します。

keepTagRevisions

integer

keepTagRevisions は、保持されるイメージストリーム内のタグのイメージリビジョンの数を指定します。デフォルトは 3 です。

keepYoungerThan

integer

keepYoungerThan は、プルーニングの候補と見なされるイメージとそのリファラーの最小年齢をナノ秒単位で指定します。非推奨: このフィールドは非推奨になり、keepYoungerThanDuration が優先されます。両方が設定されている場合、このフィールドは無視され、keepYoungerThanDuration が優先されます。

keepYoungerThanDuration

string

keepYoungerThanDuration は、プルーニングの候補と見なされるイメージとそのリファラーの最小年齢を指定します。デフォルトは 60m (60 分) です。

logLevel

string

logLevel は、プルーナージョブのログ出力のレベルを設定します。有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal".

nodeSelector

object (string)

nodeSelector は、イメージ剪定ばさみ Pod のノード選択制約を定義します。

resources

object

resources は、イメージ剪定ばさみ Pod のリソースリクエストと制限を定義します。

スケジュール

string

スケジュールは、標準の cronjob 構文を使用してジョブを実行するタイミングを指定します (https://wikipedia.org/wiki/Cron)。デフォルトは 0 0 * * * です。

successfulJobsHistoryLimit

integer

successfulJobsHistoryLimit は、保持する成功したイメージプルーナージョブの数を指定します。設定されていない場合は、デフォルトで 3 に設定されます。

suspend

boolean

suspend は、この cronjob の後続の実行を一時停止するかどうかを指定します。デフォルトは false です。

tolerations

array

tolerations は、イメージ剪定ばさみ Pod のノード許容値を定義します。

tolerations[]

object

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

14.1.2. .spec.affinity

説明
アフィニティーは、イメージ剪定ばさみ Pod のノードアフィニティースケジューリングルールのグループです。
object
Expand
プロパティータイプ説明

nodeAffinity

object

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

podAffinity

object

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

podAntiAffinity

object

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

14.1.3. .spec.affinity.nodeAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

object

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

14.1.4. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

14.1.5. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

preference

object

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

weight

integer

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

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

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

matchExpressions

array

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

matchExpressions[]

object

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

matchFields

array

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

matchFields[]

object

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

nodeSelectorTerms

array

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

nodeSelectorTerms[]

object

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

14.1.12. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms

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

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

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

matchExpressions

array

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

matchExpressions[]

object

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

matchFields

array

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

matchFields[]

object

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.18. .spec.affinity.podAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

array

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

requiredDuringSchedulingIgnoredDuringExecution[]

object

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

14.1.19. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

14.1.20. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

podAffinityTerm

object

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

weight

integer

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

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

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.25. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.28. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

14.1.29. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.33. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

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

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.36. .spec.affinity.podAntiAffinity

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

preferredDuringSchedulingIgnoredDuringExecution

array

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

preferredDuringSchedulingIgnoredDuringExecution[]

object

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

requiredDuringSchedulingIgnoredDuringExecution

array

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

requiredDuringSchedulingIgnoredDuringExecution[]

object

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

14.1.37. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution

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

14.1.38. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]

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

podAffinityTerm

object

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

weight

integer

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

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

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

labelSelector

object

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

namespaceSelector

object

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

namespace

array (string)

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

topologyKey

string

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

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

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.43. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector

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

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

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

key

string

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

operator

string

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

values

array (string)

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

14.1.46. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution

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

14.1.47. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]

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

labelSelector

object

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

namespaceSelector

object

用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。

namespace

array (string)

namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します

topologyKey

string

この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。

14.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector

説明
リソースのセット (この場合は Pod) に対するラベルクエリー。
タイプ
object
Expand
プロパティータイプ説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

14.1.49. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array

14.1.50. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]

説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティータイプ説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

14.1.51. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector

説明
用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
object
Expand
プロパティータイプ説明

matchExpressions

array

matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。

matchExpressions[]

object

ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchLabels

object (string)

matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。

14.1.52. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions

説明
matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
array
説明
ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
object
必須
  • key
  • operator
Expand
プロパティータイプ説明

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。

values

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

14.1.54. .spec.resources

説明
resources は、イメージ剪定ばさみ Pod のリソースリクエストと制限を定義します。
object
Expand
プロパティータイプ説明

limits

integer-or-string

limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

integer-or-string

requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

14.1.55. .spec.tolerations

説明
tolerations は、イメージ剪定ばさみ Pod のノード許容値を定義します。
array

14.1.56. .spec.tolerations[]

説明
この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
object
Expand
プロパティータイプ説明

effect

string

effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。

operator

string

Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。

tolerationSeconds

integer

tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。

value

string

value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。

14.1.57. .status

説明
ImagePrunerStatus は、イメージプルーナーの動作ステータスを報告します。
object
Expand
プロパティータイプ説明

conditions

array

conditions は、状態とそのステータスのリストです。

conditions[]

object

OperatorCondition は、標準の状態フィールドです。

observedGeneration

integer

observedGeneration は、適用された最後の世代の変更です。

14.1.58. .status.conditions

説明
conditions は、状態とそのステータスのリストです。
array

14.1.59. .status.conditions[]

説明
OperatorCondition は、標準の状態フィールドです。
object
Expand
プロパティータイプ説明

lastTransitionTime

string

 

message

string

 

reason

string

 

status

string

 

type

string

 

14.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/imageregistry.operator.openshift.io/v1/imagepruners

    • DELETE: ImagePruner のコレクションを削除します。
    • GET: 種類が ImagePruner のオブジェクトをリスト表示します。
    • POST: ImagePruner を作成します。
  • /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}

    • DELETE: ImagePruner を削除します。
    • GET: 指定された ImagePruner を読み取ります。
    • PATCH: 指定された ImagePruner を部分的に更新します。
    • PUT: 指定された ImagePruner を置き換えます。
  • /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}/status

    • GET: 指定された ImagePruner のステータスを読み取ります
    • PATCH: 指定された ImagePruner のステータスを部分的に更新します
    • PUT: 指定された ImagePruner のステータスを置き換えます

14.2.1. /apis/imageregistry.operator.openshift.io/v1/imagepruners

Expand
表14.1 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ImagePruner のコレクションを削除します
Expand
表14.2 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表14.3 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する ImagePruner
Expand
表14.4 クエリーパラメーター
パラメーター説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

デフォルトは unset です。

timeoutSeconds

integer

リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。

watch

boolean

記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。

Expand
表14.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImagePrunerList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ImagePruner を作成する
Expand
表14.6 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

fieldValidation

string

fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表14.7 ボディーパラメーター
パラメーター説明

body

ImagePruner スキーマ

 
Expand
表14.8 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ImagePruner スキーマ

201 - Created

ImagePruner スキーマ

202 - Accepted

ImagePruner スキーマ

401 - Unauthorized

空白

14.2.2. /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}

Expand
表14.9 グローバルパスパラメーター
パラメーター説明

name

string

ImagePruner の名前

Expand
表14.10 グローバルクエリーパラメーター
パラメーター説明

pretty

string

'true' の場合は、出力が整形表示 (Pretty-print) されます。

HTTP メソッド
DELETE
説明
ImagePruner を削除します
Expand
表14.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立し