8.5. ClusterOperator [config.openshift.io/v1]


Description
ClusterOperator は、Operator の現在の状態を保持するカスタムリソースオブジェクトです。このオブジェクトは、Operator によってそれらの状態をクラスターの残りの部分に送るために使用されます。
タイプ
object
必須
  • spec

8.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_v2

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

spec

object

spec は、任意の Operator に適用できる設定を保持します。

status

object

status は、Operator の状態に関する情報を保持します。これは、Kubernetes エコシステム全体のステータス情報と一致しています。

8.5.1.1. .spec

Description
spec は、任意の Operator に適用できる設定を保持します。
タイプ
object

8.5.1.2. .status

Description
status は、Operator の状態に関する情報を保持します。これは、Kubernetes エコシステム全体のステータス情報と一致しています。
タイプ
object
Expand
プロパティータイプ説明

conditions

array

条件は、Operator の管理および監視対象コンポーネントの状態を表します。

conditions[]

object

ClusterOperatorStatusCondition は、オペレーターの管理および監視対象コンポーネントの状態を表します。

extension

``

拡張機能には、このステータスオブジェクトを所有する Operator に固有の追加のステータス情報が含まれています。

relatedObjects

array

relatedObjects は、興味深いまたはこの Operator に関連するオブジェクトのリストです。一般的な用途は次のとおりです。1。Operator を駆動する詳細なリソース 2.Operator の名前空間 3.オペランドの名前空間

relatedObjects[]

object

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

versions

array

version は、Operator とオペランドのバージョンタプルのスライスです。複数のオペランドを管理する Operator は、配列内に複数のオペランドエントリーを持ちます。使用可能な Operator は、operator という名前の Operator 自体のバージョンを報告する必要があります。Operator は、新しいバージョンをすべてのオペランドにロールアウトすると、新しい Operator バージョンを報告します。

versions[]

object

 

8.5.1.3. .status.conditions

Description
条件は、Operator の管理および監視対象コンポーネントの状態を表します。
タイプ
array

8.5.1.4. .status.conditions[]

Description
ClusterOperatorStatusCondition は、オペレーターの管理および監視対象コンポーネントの状態を表します。
タイプ
object
必須
  • lastTransitionTime
  • status
  • type
Expand
プロパティータイプ説明

lastTransitionTime

string

lastTransitionTime は、現在のステータスプロパティーが最後に更新された時刻です。

message

string

メッセージは、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。改行文字 (U + 000A) が含まれている場合があり、改行としてレンダリングする必要があります。

reason

string

理由は、状態の現在のステータスのキャメルケースの理由です。

status

string

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

type

string

type は、この条件によって報告されるアスペクトを指定します。

8.5.1.5. .status.relatedObjects

Description
relatedObjects は、興味深いまたはこの Operator に関連するオブジェクトのリストです。一般的な用途は次のとおりです。1。Operator を駆動する詳細なリソース 2.Operator の名前空間 3.オペランドの名前空間
タイプ
array

8.5.1.6. .status.relatedObjects[]

Description
ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
タイプ
object
必須
  • group
  • name
  • resource
Expand
プロパティータイプDescription

group

string

指示対象のグループ。

name

string

参照先の名前。

namespace

string

参照先の namespace。

resource

string

指示対象のリソース。

8.5.1.7. .status.versions

Description
version は、Operator とオペランドのバージョンタプルのスライスです。複数のオペランドを管理する Operator は、配列内に複数のオペランドエントリーを持ちます。使用可能な Operator は、operator という名前の Operator 自体のバージョンを報告する必要があります。Operator は、新しいバージョンをすべてのオペランドにロールアウトすると、新しい Operator バージョンを報告します。
タイプ
array

8.5.1.8. .status.versions[]

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

name

string

name は、このバージョンの対象となる特定のオペランドの名前です。通常、Operator ではなく、コンテナーイメージと一致します。

version

string

version は、特定のオペランドのどのバージョンが現在管理されているかを示します。常に Available オペランドと一致する必要があります。1.0.0 が使用可能である場合、Operator が 1.1.0 をロールアウトしようとしても、これは 1.0.0 を示している必要があります。

8.5.2. API エンドポイント

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

  • /apis/config.openshift.io/v1/clusteroperators

    • DELETE:ClusterOperator のコレクションを削除します
    • GET: 種類 ClusterOperator のオブジェクトを一覧表示します
    • POST:ClusterOperator を作成します
  • /apis/config.openshift.io/v1/clusteroperators/{name}

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

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

8.5.2.1. /apis/config.openshift.io/v1/clusteroperators

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

pretty

string

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

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

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

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

200 - OK

Status_v2 schema

401 - Unauthorized

空白

HTTP メソッド
GET
Description
ClusterOperator の種類のオブジェクトを一覧表示します
Expand
表8.97 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

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

continue

string

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

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

fieldSelector

string

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

labelSelector

string

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

limit

integer

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

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

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

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

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

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

200 - OK

ClusterOperatorList schema

401 - Unauthorized

空白

HTTP メソッド
POST
Description
ClusterOperator を作成します
Expand
表8.99 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldManager

string

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

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

ボディー

ClusterOperator スキーマ

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

200 - OK

ClusterOperator スキーマ

201 - Created

ClusterOperator スキーマ

202 - Accepted

ClusterOperator スキーマ

401 - Unauthorized

空白

8.5.2.2. /apis/config.openshift.io/v1/clusteroperators/{name}

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

name

string

ClusterOperator の名前

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

pretty

string

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

HTTP メソッド
DELETE
Description
ClusterOperator を削除します
Expand
表8.104 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

gracePeriodSeconds

integer

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

orphanDependents

boolean

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

propagationPolicy

string

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

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

body

DeleteOptions_v2 schema

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

200 - OK

Status_v2 schema

202 - Accepted

Status_v2 schema

401 - Unauthorized

空白

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

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

200 - OK

ClusterOperator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

body

Patch schema

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

200 - OK

ClusterOperator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

ボディー

ClusterOperator スキーマ

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

200 - OK

ClusterOperator スキーマ

201 - Created

ClusterOperator スキーマ

401 - Unauthorized

空白

8.5.2.3. /apis/config.openshift.io/v1/clusteroperators/{name}/status

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

name

string

ClusterOperator の名前

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

pretty

string

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

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

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

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

200 - OK

ClusterOperator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

body

Patch schema

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

200 - OK

ClusterOperator スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldManager

string

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

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

ボディー

ClusterOperator スキーマ

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

200 - OK

ClusterOperator スキーマ

201 - Created

ClusterOperator スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat