第4章 ControlPlaneMachineSet [machine.openshift.io/v1]

replicas

integer

レプリカは、この ControlPlaneMachineSet で作成する必要のあるコントロールプレーンマシンの数を定義します。このフィールドは不変であり、クラスターのインストール後に変更することはできません。ControlPlaneMachineSet は、3 つまたは 5 つのノードコントロールプレーンでのみ動作します。このフィールドの唯一の有効な値は、3 および 5 です。

selector

object

マシンのラベルセレクター。このセレクターによって選択された既存のマシンは、この ControlPlaneMachineSet の影響を受けるマシンです。テンプレートのラベルと一致する必要があります。このフィールドは、リソースの作成後は不変と見なされます。

state

string

state は、ControlPlaneMachineSet が Active か Inactive かを定義します。Inactive の場合、ControlPlaneMachineSet はクラスター内のマシンの状態に対してアクションを実行しません。Active の場合、ControlPlaneMachineSet はマシンを調整し、必要に応じてマシンを更新します。アクティブになると、ControlPlaneMachineSet を非アクティブにすることはできません。これ以降のアクションを防ぐには、ControlPlaneMachineSet を削除してください。

strategy

object

ストラテジーは、ProviderSpec への変更を検出すると、ControlPlaneMachineSet がマシンを更新する方法を定義します。

template

object

テンプレートは、この ControlPlaneMachineSet によって作成されるコントロールプレーンマシンを記述します。

matchExpressions

array

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

matchExpressions[]

object

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

matchLabels

object (string)

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

key

string

key は、セレクターの適用先のラベルキーです。

operator

string

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

値

array (string)

values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

type

string

type は、ControlPlaneMachineSet が所有するマシンを更新するときに使用する必要のある更新ストラテジーのタイプを定義します。Valid values are "RollingUpdate" and "OnDelete".現在のデフォルト値は RollingUpdate です。

machineType

string

MachineType は、ControlPlaneMachineSet によって管理される必要があるマシンのタイプを決定します。現時点で、唯一有効な値は machines_v1beta1_machine_openshift_io です。

machines_v1beta1_machine_openshift_io

object

OpenShiftMachineV1Beta1Machine は、v1beta1.machine.openshift.io API グループからマシンを作成するためのテンプレートを定義します。

failureDomains

object

FailureDomains は、ControlPlaneMachineSet がコントロールプレーンマシンのバランスを取る必要がある障害ドメイン（アベイラビリティーゾーンと呼ばれることもあります）のリストです。これは、テンプレートに指定された ProviderSpec にマージされます。このフィールドは、配置情報を必要としないプラットフォームではオプションになります。

metadata

object

ObjectMeta は標準のオブジェクトメタデータです。詳細： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata ControlPlaneMachineSet セレクターと一致させるにはラベルが必要です。

spec

object

spec には、コントロールプレーンマシンの必要な設定が含まれています。ProviderSpec の内部には、コントロールプレーンマシンを作成するためのプラットフォーム固有の詳細が含まれています。ProviderSe は、プラットフォーム固有の障害ドメインフィールドとは別に完了する必要があります。これは、FailureDomains フィールドに基づいてマシンが作成されると上書きされます。

aws

array

AWS は、AWS プラットフォームの障害ドメイン情報を設定します。

aws[]

object

AWSFailureDomain は、AWS プラットフォームの障害ドメイン情報を設定します。

azure

array

Azure は、Azure プラットフォームの障害ドメイン情報を設定します。

azure[]

object

AzureFailureDomain は、Azure プラットフォームの障害ドメイン情報を設定します。

gcp

array

GCP は、GCP プラットフォームの障害ドメイン情報を設定します。

gcp[]

object

GCPFailureDomain は、GCP プラットフォームの障害ドメイン情報を設定します。

platform

string

プラットフォームは、FailureDomain が表すプラットフォームを識別します。現在サポートされている値は AWS、Azure、および GCP です。

placement

object

Placement は、このインスタンスの配置情報を設定します。

subnet

object

subnet は、このインスタンスに使用するサブネットへの参照です。

availabilityZone

string

availabilityZone は、インスタンスのアベイラビリティーゾーンです。

arn

string

リソースの ARN。

filters

array

Filters は、リソースの識別に使用されるフィルターのセットです。

filters[]

object

AWSResourceFilter は、AWS リソースを識別するために使用されるフィルターです。

id

string

リソースの ID。

type

string

type は、参照が AWS リソースをフェッチする方法を決定します。

name

string

フィルターの名前。フィルター名では、大文字と小文字が区別されます。

values

array (string)

値には、1 つ以上のフィルター値が含まれます。フィルター値では、大文字と小文字が区別されます。

zone

string

仮想マシンのアベイラビリティーゾーン。nil の場合、仮想マシンはゾーンなしでデプロイする必要があります。

zone

string

zone は、GCP マシンプロバイダーが仮想マシンを作成するゾーンです。

annotations

object (string)

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

labels

object (string)

オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細は、http://kubernetes.io/docs/user-guide/labels を参照してください。このフィールドには、'machine.openshift.io/cluster-api-machine-role' ラベルと 'machine.openshift.io/cluster-api-machine-type' ラベルの両方が含まれている必要があります。どちらも 'master' の値を使用します。また、キーが 'machine.openshift.io/cluster-api-cluster' のラベルが含まれる必要もあります。

ライフサイクルフック

object

LifecycleHooks を使用すると、ユーザーはマシンライフサイクル内の特定の事前に定義されたポイントでマシンの操作を一時停止できます。

metadata

object

ObjectMeta は、作成されたノードに自動入力します。これを使用して、ノードの作成時に使用するラベル、アノテーション、名前接頭辞などを示します。

providerID

string

ProviderID は、プロバイダーによって提供されたマシンの ID です。このフィールドは、このマシンに対応するノードオブジェクトに表示されるプロバイダー ID と一致する必要があります。このフィールドは、cluster-api の上位レベルのコンシューマーに必要です。ユースケースの例は、プロバイダーとして cluster-api を使用するクラスターオートスケーラーです。オートスケーラーのクリーンアップロジックは、マシンをノードと比較して、Kubernetes ノードとして登録できなかったプロバイダーのマシンを見つけます。オートスケーラーの一般的なツリー外プロバイダーとして cluster-api を使用する場合、このフィールドは、マシンのリストのプロバイダービューを持つことができるようにするためにオートスケーラーによって必要とされます。k8s apiserver からノードの別のリストが照会され、比較が行われて未登録のマシンが検出され、削除のマークが付けられます。このフィールドはアクチュエーターによって設定され、汎用プロバイダーとして cluster-api とインターフェイスするオートスケーラーなどの高レベルのエンティティーによって消費されます。

providerSpec

object

ProviderSpec の詳細ノードの作成中に使用するプロバイダー固有の設定。

taints

array

対応するノードに追加的に適用されるテイントのリスト。このリストは、他のエンティティーによって継続的にノードに追加された他のテイントを上書きしません。これらのテイントは積極的に調整する必要があります。たとえば、マシンコントローラーにテイントを適用するように依頼し、手動でテイントを除去すると、マシンコントローラーはテイントを元に戻します)、マシンコントローラーにテイントを除去させないでください。

taints[]

object

このテイントが接続されているノードは、テイントを許容しない Pod に影響を及ぼします。

preDrain

array

preDrain フックは、マシンがドレインされないようにします。これにより、終了などの追加のライフサイクルイベントもブロックされます。

preDrain[]

object

LifecycleHook は、ライフサイクルフックの単一のインスタンスを表します

preTerminate

array

preTerminate フックは、マシンが終了されないようにします。preTerminate フックは、マシンがドレインされた後に処理されます。

preTerminate[]

object

LifecycleHook は、ライフサイクルフックの単一のインスタンスを表します

name

string

name は、リフリサイクルフックの一意の名前を定義します。名前は一意で説明的なものである必要があります。理想的には、CamelCase では 1-3 単語である必要があります。または、namespace を使用する場合があります（例：foo.example.com/CamelCase）。名前は一意でなければならず、単一のエンティティーでのみ管理する必要があります。

owner

string

所有者はライフサイクルフックの所有者を定義します。これは、ユーザーがライフサイクルをブロックするユーザーを識別できるように、わかりやすいものである必要があります。これは、コントローラーの名前(clusteroperator/etcd など)またはフックを管理する管理者である可能性があります。

name

string

name は、リフリサイクルフックの一意の名前を定義します。名前は一意で説明的なものである必要があります。理想的には、CamelCase では 1-3 単語である必要があります。または、namespace を使用する場合があります（例：foo.example.com/CamelCase）。名前は一意でなければならず、単一のエンティティーでのみ管理する必要があります。

owner

string

所有者はライフサイクルフックの所有者を定義します。これは、ユーザーがライフサイクルをブロックするユーザーを識別できるように、わかりやすいものである必要があります。これは、コントローラーの名前(clusteroperator/etcd など)またはフックを管理する管理者である可能性があります。

annotations

object (string)

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

generateName

string

generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返しません。代わりに、割り当てられた時間内に一意の名前が見つからなかったことを示す ReasonServerTimeout で 201Created または 500 を返します。クライアントは再試行する必要があります (オプションで、Retry-After ヘッダーに示されている時間の後)。Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

labels

object (string)

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

name

string

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

namespace

string

名前空間は、各名前内のスペースが一意である必要があることを定義します。空の namespace は "default" の namespace と同じですが、"default" は正規表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。DNS_LABEL である必要があります。更新はできません。詳細: http://kubernetes.io/docs/user-guide/namespaces

ownerReferences

array

このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。

ownerReferences[]

object

OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。

apiVersion

string

参照先の API バージョン。

blockOwnerDeletion

ブール値

true の場合、および所有者が foregroundDeletion ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の削除権限を必要とします。そうしないと、422(処理不能エンティティー) が返されます。

controller

ブール値

true の場合、この参照は管理コントローラーを指します。

kind

string

参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: http://kubernetes.io/docs/user-guide/identifiers#names

uid

string

参照先の UID。詳細: http://kubernetes.io/docs/user-guide/identifiers#uids

value

``

値は、リソース設定のインライン化されたシリアル化された表現です。プロバイダーは、コンポーネント設定と同様に、このフィールドからシリアル化/逆シリアル化する必要がある独自のバージョン管理された API タイプを維持することを推奨します。

effect

string

必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。

key

string

必須。ノードに適用されるテイントキー。

timeAdded

string

TimeAdded は、テイントが追加された時刻を表します。NoExecute テイントのためにのみ書かれています。

value

string

テイントキーに対応するテイント値。

conditions

array

条件は、ControlPlaneMachineSet の現在の状態の観察を表します。既知の .status.conditions.type は次のとおりです。Available、Degraded、および Progressing です。

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" // その他のフィールド}

observedGeneration

integer

observedGeneration は、この ControlPlaneMachineSet で観察された最新の世代です。これは、API サーバーによる変更時に更新される ControlPlaneMachineSet の生成に対応します。

readyReplicas

integer

readyReplicas は、準備ができている ControlPlaneMachineSet コントローラーによって作成されたコントロールプレーンマシンの数です。この値は、ローリング更新が進行中の間は、希望するレプリカ数よりも大きくなる可能性があることに注意してください。

replicas

integer

レプリカは、ControlPlaneMachineSet コントローラーによって作成されたコントロールプレーンマシンの数です。更新操作中に、この値は必要なレプリカ数とは異なる可能性があることに注意してください。

unavailableReplicas

integer

UnavailableReplicas は、ControlPlaneMachineSet が必要な容量に達する前に必要なコントロールプレーンマシンの数です。この値がゼロ以外の場合、ReadyReplicas の数は目的の Replicas 未満になります。

updatedReplicas

integer

updatedReplicas は、目的のプロバイダー仕様があり、準備が整っている ControlPlaneMachineSet コントローラーによって作成される、終了していないコントロールプレーンマシンの数です。この値は、目的の仕様に変更が検出されると 0 に設定されます。更新ストラテジーが RollingUpdate の場合、これはマシンの更新プロセスの開始にも対応します。更新ストラテジーが OnDelete の場合、ユーザーが既存のレプリカを削除し、置換の準備が整うまで、この値は 0 のままになります。

lastTransitionTime

string

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

message

string

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

observedGeneration

integer

observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 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) です。