12.3. ControllerConfig [machineconfiguration.openshift.io/v1]
- Description
- ControllerConfig は、MachineConfigController の設定について説明しています。これは現在、TemplateController によって生成された MachineConfig オブジェクトを駆動するためにのみ使用されます。
- タイプ
-
object
- 必須
-
spec
-
12.3.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
プロパティー | タイプ | 説明 |
---|---|---|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| ControllerConfigSpec は、ControllerConfig リソースの仕様です。 |
|
| ControllerConfigStatus は、ControllerConfig のステータスです。 |
12.3.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ControllerConfigSpec は、ControllerConfig リソースの仕様です。
- タイプ
-
object
- 必須
-
cloudProviderConfig
-
clusterDNSIP
-
images
-
ipFamilies
-
kubeAPIServerServingCAData
-
osImageURL
-
releaseImage
-
rootCAData
-
プロパティー | タイプ | Description |
---|---|---|
| `` | additionalTrustBundle は、ノードの信頼できる証明書ストアに追加される証明書バンドルです。 |
| `` | cloudProvider は、クラウドプロバイダーの CA データを指定します |
|
| cloudProviderConfig は、特定のクラウドプロバイダーの設定です |
|
| clusterDNSIP は、クラスター DNSIP アドレスです。 |
| `` | dns はクラスター DNS の詳細を保持します |
|
| etcdDiscoveryDomain は非推奨です。代わりに、Infra.Status.EtcdDiscoveryDomain を使用してください。 |
|
| images は、コントローラーが./templates/の下にテンプレートをレンダリングするために使用するイメージのマップです。 |
| `` | インフラストラクチャーの詳細を保持するインフラストラクチャー |
|
| ipFamilies は、クラスターネットワークで使用されている IP ファミリーを示します |
|
| kubeAPIServerServingCAData が管理する Kubelet から API サーバー証明書へ…自動的にローテーション |
|
| networkType は、クラスターが XXX を使用しているネットワークのタイプを保持します。これは一時的なものであり、ネットワーク関連サービスを適切な方法で開始するためのより良いサポートのために、できるだけ早く削除されます。クラスターが最初に起動して実行されると、誰もこれを変更しないため、これが変更された場合は再生成を許可しないでください。 |
|
| osImageURL は、OS 更新ペイロードを含むコンテナーイメージの場所です。その値は、machine-config-osimageurlConfigMap の data.osImageURL フィールドから取得されます。 |
|
| プラットフォームは非推奨です。代わりに Infra.Status.PlatformStatus.Type を使用してください |
| `` | プロキシーは、ノードの現在のプロキシー設定を保持します |
|
| pullSecret は、すべてのマシンにインストールする必要があるデフォルトのプルシークレットです。 |
|
| releaseImage は、クラスターのインストール時に使用されるイメージです |
|
| rootCAData は、ルート CA データを指定します |
12.3.1.2. .spec.pullSecret リンクのコピーリンクがクリップボードにコピーされました!
- Description
- pullSecret は、すべてのマシンにインストールする必要があるデフォルトのプルシークレットです。
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、spec.containers{name} などの値に設定されます (name はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、spec.containers[2] の値に設定されます (この Pod 内でインデックス が 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。 |
|
| 参照先の種類。詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
12.3.1.3. .status リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ControllerConfigStatus は、ControllerConfig のステータスです。
- タイプ
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 条件は、現在の状態の最新の利用可能な観測を表します。 |
|
| ControllerConfigStatusCondition には、ControllerConfigStatus の条件情報が含まれています |
|
| observedGeneration は、コントローラーによって監視された世代を表します。 |
12.3.1.4. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 条件は、現在の状態の最新の利用可能な観測を表します。
- タイプ
-
array
12.3.1.5. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ControllerConfigStatusCondition には、ControllerConfigStatus の条件情報が含まれています
- タイプ
-
object
- 必須
-
status
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
| `` | lastTransitionTime は、現在のステータスオブジェクトが最後に更新された時刻です。 |
|
| メッセージは、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。 |
|
| reason は、条件の最後の遷移の理由です。理由は PascalCase です |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| type は、Operator の調整機能の状態を指定します。 |
12.3.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/machineconfiguration.openshift.io/v1/controllerconfigs
-
DELETE
:ControllerConfig のコレクションを削除します -
GET
: 種類 ControllerConfig のオブジェクトを一覧表示します -
POST
:ControllerConfig を作成します
-
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}
-
削除
:ControllerConfig を削除します -
GET
: 指定された ControllerConfig を読み取ります -
PATCH
: 指定された ControllerConfig を部分的に更新します -
PUT
: 指定された ControllerConfig を置き換えます
-
/apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status
-
GET
: 指定された ControllerConfig のステータスを読み取ります -
PATCH
: 指定された ControllerConfig のステータスを部分的に更新します -
PUT
: 指定された ControllerConfig のステータスを置き換えます
-
12.3.2.1. /apis/machineconfiguration.openshift.io/v1/controllerconfigs リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- ControllerConfig のコレクションを削除します
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- ControllerConfig の種類のオブジェクトを一覧表示します
パラメーター | タイプ | 説明 |
---|---|---|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- Description
- ControllerConfig を作成します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
12.3.2.2. /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name} リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| ControllerConfig の名前 |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE
- Description
- ControllerConfig を削除します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- Description
- 指定された ControllerConfig を読み取ります
パラメーター | タイプ | 説明 |
---|---|---|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定された ControllerConfig を部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定された ControllerConfig を置き換えます
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
12.3.2.3. /apis/machineconfiguration.openshift.io/v1/controllerconfigs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
パラメーター | タイプ | 説明 |
---|---|---|
|
| ControllerConfig の名前 |
パラメーター | タイプ | 説明 |
---|---|---|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
GET
- Description
- 指定された ControllerConfig のステータスを読み取ります
パラメーター | タイプ | 説明 |
---|---|---|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- Description
- 指定された ControllerConfig のステータスを部分的に更新します
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- Description
- 指定された ControllerConfig のステータスを置き換えます
パラメーター | タイプ | 説明 |
---|---|---|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
パラメーター | タイプ | 説明 |
---|---|---|
|
|
HTTP コード | レスポンス本文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |