第6章 ClusterVersion [config.openshift.io/v1]


Description
ClusterVersion は、ClusterVersionOperator の設定です。ここで、自動更新に関連するパラメーターを設定できます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
object
必須
  • spec

6.1. 仕様

プロパティー説明

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 は、クラスターバージョンの望ましい状態です。Operator は、望ましいバージョンがクラスターに適用されていることを確認するために作業します。

status

object

status には、利用可能な更新と進行中の更新に関する情報が含まれます。

6.1.1. .spec

Description
spec は、クラスターバージョンの望ましい状態です。Operator は、望ましいバージョンがクラスターに適用されていることを確認するために作業します。
タイプ
object
必須
  • clusterID
プロパティー説明

capabilities

object

機能 は、オプションのコアクラスターコンポーネントのインストールを設定します。ここでの null 値は空のオブジェクトと同じです。デフォルトセマンティクスの子プロパティーを参照してください。

channel

string

channel は、デフォルト以外の一連の更新をこのクラスターに適用することを明示的に要求するための ID です。デフォルトのチャネルには、本番クラスターに適した安定した更新が含まれます。

clusterID

string

clusterID は、このクラスターを一意に識別します。これは、RFC4122 UUID 値 (16 進値の xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) であると予想されます。これは必須フィールドです。

desiredUpdate

object

desiredUpdate は、クラスターバージョンの目的の値を示すオプションのフィールドです。この値を設定すると、アップグレードがトリガーされます (現在のバージョンが目的のバージョンと一致しない場合)。推奨される更新値のセットは、ステータスで利用可能な更新の一部としてリストされており、その範囲外の値を設定すると、アップグレードが失敗する可能性があります。availableUpdates または履歴にそのバージョンの更新が存在する場合は、イメージを設定せずにバージョンフィールドを指定できます。アップグレードが失敗した場合、Operator は停止し、失敗したコンポーネントに関するステータスを報告します。目的の更新値を以前のバージョンに戻すと、ロールバックが試行されます。すべてのロールバックが成功するわけではありません。

overrides

array

オーバーライドは、クラスターバージョン Operator によって管理されるコンポーネントのオーバーライドのリストです。コンポーネントにマネージド外のマークを付けると、Operator はオブジェクトを作成または更新できなくなります。

overrides[]

object

ComponentOverride を使用すると、コンポーネントに対するクラスターバージョン Operator の動作をオーバーライドできます。

upstream

string

アップストリームを使用して、優先する更新サーバーを指定できます。デフォルトでは、クラスターとリージョンに適切な更新サーバーを使用します。

6.1.2. .spec.capabilities

説明
機能 は、オプションのコアクラスターコンポーネントのインストールを設定します。ここでの null 値は空のオブジェクトと同じです。デフォルトセマンティクスの子プロパティーを参照してください。
object
プロパティー説明

additionalEnabledCapabilities

array (string)

additionalEnabledCapabilities は、baselineCapabilitySet で定義されたベースラインを超えて管理機能のセットを拡張します。デフォルトは空のセットです。

baselineCapabilitySet

string

baselineCapabilitySet は、有効にするオプション機能の初期セットを選択します。これは、additionalEnabledCapabilities を介して拡張できます。設定されていない場合、クラスターはデフォルトを選択します。デフォルトは時間の経過とともに変更される可能性があります。現在のデフォルトは vCurrent です。

6.1.3. .spec.desiredUpdate

Description
desiredUpdate は、クラスターバージョンの目的の値を示すオプションのフィールドです。この値を設定すると、アップグレードがトリガーされます (現在のバージョンが目的のバージョンと一致しない場合)。推奨される更新値のセットは、ステータスで利用可能な更新の一部としてリストされており、その範囲外の値を設定すると、アップグレードが失敗する可能性があります。availableUpdates または履歴にそのバージョンの更新が存在する場合は、イメージを設定せずにバージョンフィールドを指定できます。アップグレードが失敗した場合、Operator は停止し、失敗したコンポーネントに関するステータスを報告します。目的の更新値を以前のバージョンに戻すと、ロールバックが試行されます。すべてのロールバックが成功するわけではありません。
タイプ
object
プロパティーDescription

force

boolean

Force を使用すると、管理者は検証またはアップグレード可能なチェックに失敗したイメージに更新できます。このオプションは、提供されたイメージがクラスターへの完全な管理アクセスで実行されるため、提供されたイメージの信頼性が帯域外で検証された場合にのみ使用する必要があります。未知の、または潜在的に悪意のあるソースからのイメージには、このフラグを使用しないでください。

image

string

image は、更新を含むコンテナーイメージの場所です。このフィールドが仕様の一部である場合、バージョンが指定されていて、availableUpdates フィールドに一致するバージョンが含まれている場合、イメージはオプションです。

version

string

version は、更新バージョンを識別するセマンティックバージョニングです。このフィールドが仕様の一部である場合、イメージが指定されている場合、バージョンはオプションです。

6.1.4. .spec.overrides

Description
オーバーライドは、クラスターバージョン Operator によって管理されるコンポーネントのオーバーライドのリストです。コンポーネントにマネージド外のマークを付けると、Operator はオブジェクトを作成または更新できなくなります。
タイプ
array

6.1.5. .spec.overrides[]

Description
ComponentOverride を使用すると、コンポーネントに対するクラスターバージョン Operator の動作をオーバーライドできます。
タイプ
object
必須
  • group
  • kind
  • name
  • namespace
  • unmanaged
プロパティー説明

group

string

group は、種類が含まれる API グループを識別します。

kind

string

kind は、オーバーライドするオブジェクトを識別します。

name

string

name はコンポーネントの名前です。

namespace

string

名前空間は、コンポーネントの名前空間です。リソースがクラスタースコープの場合、名前空間は空である必要があります。

unmanaged

ブール値

クラスターバージョン Operator がこのクラスター内のリソースの管理を停止する必要がある場合は、アンマネージドコントロール。デフォルト: false

6.1.6. .status

Description
status には、利用可能な更新と進行中の更新に関する情報が含まれます。
タイプ
object
必須
  • desired
  • observedGeneration
  • versionHash
プロパティーDescription

availableUpdates

``

availableUpdates には、このクラスターに推奨される更新が含まれています。conditionalUpdates に表示されますが、availableUpdates にはない更新により、このクラスターが既知の問題にさらされる可能性があります。更新が推奨されていない場合、更新サービスが利用できない場合、または無効なチャネルが指定されている場合、このリストは空になる可能性があります。

capabilities

object

capabilities は、オプションのコアクラスターコンポーネントの状態を記述します。

conditionalUpdates

array

conditionalUpdates には、特定の必要な条件を満たす場合にこのクラスターに推奨される可能性のある更新のリストが含まれています。このクラスターに実際に推奨される更新のセットに関心のあるコンシューマーは、availableUpdates を使用する必要があります。更新が推奨されていない場合、更新サービスが利用できない場合、または無効なチャネルが指定されている場合、このリストは空になる可能性があります。

conditionalUpdates[]

object

ConditionalUpdate は、現在のクラスターの一部のクラスターに対して推奨される更新を表しますが、現在のクラスターには推奨されません。

conditions

array

条件は、クラスターのバージョンに関する情報を提供します。条件 Available は、desiredUpdate に達した場合に true に設定されます。更新が適用されている場合、条件進行中は true に設定されます。更新が一時的または永続的なエラーによって現在ブロックされている場合、条件劣化は true に設定されます。条件は、metadata.generation が status.generation と等しい場合に、現在の desiredUpdate に対してのみ有効です。

conditions[]

object

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

desired

object

必要なのは、クラスターが調整しているバージョンです。クラスターがまだ完全に初期化されていない場合は、イメージやタグなどの利用可能な情報が必要になります。

history

array

履歴には、クラスターに適用された最新バージョンのリストが含まれます。この値は、クラスターの起動時に空になる場合があり、新しい更新が適用されるときに更新されます。最新の更新はリストの最初にあり、最新の順序で並べられています。ロールアウトが完了した場合、履歴の更新の状態は Completed になります。更新が失敗した場合、または途中で適用された場合、状態は Partial になります。限られた量の更新履歴のみが保持されます。

history[]

object

UpdateHistory は、クラスターに対して 1 回試行された更新です。

observedGeneration

integer

observedGeneration は、同期されている仕様のバージョンを報告します。この値が metadata.generation と等しくない場合、目的のフィールドと条件フィールドは以前のバージョンを表している可能性があります。

versionHash

string

versionHash は、クラスターが更新されるコンテンツのフィンガープリントです。不必要な作業を避けるために Operator が使用し、内部使用のみを目的としています。

6.1.7. .status.capabilities

説明
capabilities は、オプションのコアクラスターコンポーネントの状態を記述します。
object
プロパティー説明

enabledCapabilities

array (string)

EnabledCapabilities は、現在管理されているすべての機能を一覧表示します。

knownCapabilities

array (string)

knownCapabilities は、現在のクラスターに認識されているすべての機能を一覧表示します。

6.1.8. .status.conditionalUpdates

説明
conditionalUpdates には、特定の必要な条件を満たす場合にこのクラスターに推奨される可能性のある更新のリストが含まれています。このクラスターに実際に推奨される更新のセットに関心のあるコンシューマーは、availableUpdates を使用する必要があります。更新が推奨されていない場合、更新サービスが利用できない場合、または無効なチャネルが指定されている場合、このリストは空になる可能性があります。
array

6.1.9. .status.conditionalUpdates[]

説明
ConditionalUpdate は、現在のクラスターの一部のクラスターに対して推奨される更新を表しますが、現在のクラスターには推奨されません。
object
必須
  • release
  • risks
プロパティー説明

conditions

array

条件は、条件付き更新の現在のステータスの監視を表します。既知のタイプは次のとおりです。* クラスターバージョンの Operator が risks[].matchingRules を評価しようとするかどうかの評価。* 現在のクラスターに更新が推奨されるかどうかについて、推奨しています。

conditions[]

object

条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパス.status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" //その他のフィールド}

release

object

release は更新のターゲットです。

risks

array

リスクは、ターゲットリリースへの更新に関連する問題の範囲を表します。cluster-version Operator はすべてのエントリーを評価し、エントリーが 1 つ以上あり、すべてのエントリーが更新を推奨する場合にのみ更新を推奨します。

risks[]

object

ConditionalUpdateRisk は条件付き更新を推奨しない理由とクラスターの状態を表します。

6.1.10. .status.conditionalUpdates[].conditions

説明
条件は、条件付き更新の現在のステータスの監視を表します。既知のタイプは次のとおりです。* クラスターバージョンの Operator が risks[].matchingRules を評価しようとするかどうかの評価。* 現在のクラスターに更新が推奨されるかどうかについて、推奨しています。
array

6.1.11. .status.conditionalUpdates[].conditions[]

説明
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパス.status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" //その他のフィールド}
object
必須
  • lastTransitionTime
  • message
  • reason
  • status
  • type
プロパティー説明

lastTransitionTime

string

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

message

string

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

observedGeneration

integer

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

reason

string

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

status

string

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

type

string

CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。

6.1.12. .status.conditionalUpdates[].release

説明
release は更新のターゲットです。
object
プロパティーDescription

channels

array (string)

チャネルは、リリースが現在属しているシンシナティチャネルのセットです。

image

string

image は、更新を含むコンテナーイメージの場所です。このフィールドが仕様の一部である場合、バージョンが指定されていて、availableUpdates フィールドに一致するバージョンが含まれている場合、イメージはオプションです。

url

string

url には、このリリースに関する情報が含まれています。この URL は、リリースの url メタデータプロパティーまたは更新 API によって返されるメタデータによって設定され、ユーザーインターフェイスにリンクとして表示される必要があります。URL フィールドは、テストリリースまたは夜間リリースには設定されない場合があります。

version

string

version は、更新バージョンを識別するセマンティックバージョニングです。このフィールドが仕様の一部である場合、イメージが指定されている場合、バージョンはオプションです。

6.1.13. .status.conditionalUpdates[].risks

説明
リスクは、ターゲットリリースへの更新に関連する問題の範囲を表します。cluster-version Operator はすべてのエントリーを評価し、エントリーが 1 つ以上あり、すべてのエントリーが更新を推奨する場合にのみ更新を推奨します。
array

6.1.14. .status.conditionalUpdates[].risks[]

説明
ConditionalUpdateRisk は条件付き更新を推奨しない理由とクラスターの状態を表します。
object
必須
  • matchingRules
  • message
  • name
  • url
プロパティー説明

matchingRules

array

matchingRules は、リスクに一致するクラスターとないクラスターを決定するための条件のスライスです。スライスは、優先順位を下げることで順序付けられます。cluster-version Operator はスライスを順番に調整し、最初に正常に評価できる後に停止します。正常に評価できない場合、更新は推奨されません。

matchingRules[]

object

ClusterCondition は、入力したクラスターの状態の結合です。type プロパティーは、関連するタイプ固有のプロパティーを決定します。クラスターで評価されると、条件が一致したり、一致せず、評価に失敗する可能性があります。

message

string

Message は、一致するRules がクラスターの状態に一致するイベントで、更新のリスクに関する追加情報を提供します。これは人間によってのみ消費されます。改行文字 (U + 000A) が含まれている場合があり、改行としてレンダリングする必要があります。

name

string

name は、matchRules がクラスターの状態に一致するイベントで、条件付き更新を推奨しない CamelCase の理由です。

url

string

url には、このリリースに関する情報が含まれています。

6.1.15. .status.conditionalUpdates[].risks[].matchingRules

説明
matchingRules は、リスクに一致するクラスターとないクラスターを決定するための条件のスライスです。スライスは、優先順位を下げることで順序付けられます。cluster-version Operator はスライスを順番に調整し、最初に正常に評価できる後に停止します。正常に評価できない場合、更新は推奨されません。
array

6.1.16. .status.conditionalUpdates[].risks[].matchingRules[]

説明
ClusterCondition は、入力したクラスターの状態の結合です。type プロパティーは、関連するタイプ固有のプロパティーを決定します。クラスターで評価されると、条件が一致したり、一致せず、評価に失敗する可能性があります。
object
必須
  • type
プロパティー説明

promQL

object

PromQL は、PromQL に基づいてクラスターの状態を表します。

type

string

type は cluster-condition タイプを表します。これは、追加プロパティーのメンバーとセマンティクスを定義します。

6.1.17. .status.conditionalUpdates[].risks[].matchingRules[].promql

説明
PromQL は、PromQL に基づいてクラスターの状態を表します。
object
必須
  • promQL
プロパティー説明

promQL

string

PromQL は、クラスターを分類する PromQL クエリーです。このクエリーは、一致ケースで 1 を、does-not-match ケースで 0 を返す必要があります。時系列を返すクエリー、または 0 または 1 以外の値を返すクエリーは、評価の失敗です。

6.1.18. .status.conditions

Description
条件は、クラスターのバージョンに関する情報を提供します。条件 Available は、desiredUpdate に達した場合に true に設定されます。更新が適用されている場合、条件進行中は true に設定されます。更新が一時的または永続的なエラーによって現在ブロックされている場合、条件劣化は true に設定されます。条件は、metadata.generation が status.generation と等しい場合に、現在の desiredUpdate に対してのみ有効です。
タイプ
array

6.1.19. .status.conditions[]

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

lastTransitionTime

string

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

message

string

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

reason

string

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

status

string

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

type

string

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

6.1.20. .status.desired

Description
必要なのは、クラスターが調整しているバージョンです。クラスターがまだ完全に初期化されていない場合は、イメージやタグなどの利用可能な情報が必要になります。
タイプ
object
プロパティーDescription

channels

array (string)

チャネルは、リリースが現在属しているシンシナティチャネルのセットです。

image

string

image は、更新を含むコンテナーイメージの場所です。このフィールドが仕様の一部である場合、バージョンが指定されていて、availableUpdates フィールドに一致するバージョンが含まれている場合、イメージはオプションです。

url

string

url には、このリリースに関する情報が含まれています。この URL は、リリースの url メタデータプロパティーまたは更新 API によって返されるメタデータによって設定され、ユーザーインターフェイスにリンクとして表示される必要があります。URL フィールドは、テストリリースまたは夜間リリースには設定されない場合があります。

version

string

version は、更新バージョンを識別するセマンティックバージョニングです。このフィールドが仕様の一部である場合、イメージが指定されている場合、バージョンはオプションです。

6.1.21. .status.history

Description
履歴には、クラスターに適用された最新バージョンのリストが含まれます。この値は、クラスターの起動時に空になる場合があり、新しい更新が適用されるときに更新されます。最新の更新はリストの最初にあり、最新の順序で並べられています。ロールアウトが完了した場合、履歴の更新の状態は Completed になります。更新が失敗した場合、または途中で適用された場合、状態は Partial になります。限られた量の更新履歴のみが保持されます。
タイプ
array

6.1.22. .status.history[]

Description
UpdateHistory は、クラスターに対して 1 回試行された更新です。
タイプ
object
必須
  • image
  • startedTime
  • state
  • 検証済み
プロパティー説明

acceptedRisks

string

acceptedRisks は、更新を開始するために受け入れられたリスクを記録します。たとえば、Upgradeable=False、desiredUpdate.force によってオーバーライドされた署名がない、または、推奨更新ターゲットの availableUpdates セットにないにもかかわらず、開始された更新が原因として確認される場合があります。

completionTime

``

設定されている場合、completionTime は、更新が完全に適用されたときです。現在適用されている更新の完了時間は null になります。完了時間は、現在の更新ではないエントリー (通常は次の更新の開始時間) に常に設定されます。

image

string

image は、更新を含むコンテナーイメージの場所です。この値は常に入力されます。

startedTime

string

startTime は、更新が開始された時刻です。

state

string

状態は、更新が完全に適用されたかどうかを反映します。部分状態は、更新が完全に適用されていないことを示し、完了状態は、更新が少なくとも 1 回正常にロールアウトされたことを示します (更新のすべての部分が正常に適用されました)。

検証済み

ブール値

検証済みは、提供された更新がインストール前に適切に検証されたかどうかを示します。これが false の場合、クラスターは信頼されていない可能性があります。verified は、更新ターゲットが受け入れられる時点のクラスターの状態に依存する、アップグレード可能なチェックをカバーしません。

version

string

version は、更新バージョンを識別するセマンティックバージョニングです。要求されたイメージがバージョンを定義していない場合、またはイメージの取得に失敗した場合、この値は空である可能性があります。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.