Operator API
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 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.6. Config [imageregistry.operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Config は、レジストリー Operator によって管理されるレジストリーインスタンスの設定オブジェクトです。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.7. Config [samples.operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Config には、Samples Operator の設定と詳細な条件ステータスが含まれています。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
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 リソースを公開するサービスに外部トラフィックが到達できるようになります。このリソースを更新すると、新しい Ingress コントローラーのリビジョンが公開される可能性があるため、一般向けのネットワーク接続が中断される可能性があります。
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. MachineConfiguration [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
MachineConfiguration は、マシン設定を管理する Operator を設定するための情報を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.21. Network [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ネットワークは、クラスターの目的のネットワーク設定を表します。これは、cluster-network-operator によって消費されます。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.22. OpenShiftAPIServer [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
OpenShiftAPIServer は、openshift-apiserver を管理するための Operator を設定するための情報を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.23. OpenShiftControllerManager [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
OpenShiftControllerManager は、openshift-controller-manager を管理するように Operator を設定するための情報を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.24. OperatorPKI [network.operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
OperatorPKI は、単純な認証局です。これは外部での使用を目的としたものではなく、ネットワーク Operator の内部で使用されます。CNO は、CA とその CA によって署名された証明書を作成します。証明書では、ClientAuth と ServerAuth の両方の拡張使用が有効になっています。
More specifically, given an OperatorPKI with <name>, the CNO will manage:
More specifically, given an OperatorPKI with <name>, the CNO will manage:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 次の 2 つのデータキーを持つ <name>-ca という名前の Secret:
- tls.key - 秘密鍵
- tls.crt - CA 証明書
- 次の 1 つのデータキーを持つ <name>-ca という名前の ConfigMap:
- cabundle.crt - CA 証明書
- 次の 2 つのデータキーを持つ <name>-cert という名前の Secret:
- tls.key - 秘密鍵
- tls.crt - CA によって署名された証明書
CA 証明書の有効期間は 10 年で、9 年後にローテーションされます。ターゲット証明書の有効期間は 6 カ月で、3 カ月後にローテーションされます。
CA 証明書の CommonName は、"<namespace>_<name>-ca@<timestamp>" になります。<timestamp> は最後のローテーション時間です。
- 型
-
object
1.25. ServiceCA [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ServiceCA は、サービス証明書コントローラーを管理するために Operator を設定するための情報を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
1.26. 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. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 | |
|
|
| |
|
|
|
2.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
2.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| oauthAPIServer は、oauth-apiserver にのみ固有のステータスを保持します |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
2.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
2.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
2.1.5. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
2.1.6. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| resource は追跡対象のリソースタイプです。 |
2.1.7. .status.oauthAPIServer リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- oauthAPIServer は、oauth-apiserver にのみ固有のステータスを保持します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- 認証のコレクションを削除する
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Authentication のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- 認証の作成
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
2.2.2. /apis/operator.openshift.io/v1/authentications/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 認証の名前 |
- HTTP メソッド
-
DELETE - 説明
- 認証の削除
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された認証を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された認証を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された認証を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
2.2.3. /apis/operator.openshift.io/v1/authentications/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 認証の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された認証のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された認証のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された認証のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第3章 CloudCredential [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
CloudCredential は、CredentialsRequests を管理するように Operator を設定する手段を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
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 | |
|
|
| CloudCredentialSpec は、cloud-credential-operator の望ましい動作の仕様です。 |
|
|
| CloudCredentialStatus は、cloud-credential-operator の監視ステータスを定義します。 |
3.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- CloudCredentialSpec は、cloud-credential-operator の望ましい動作の仕様です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| credentialsMode を使用すると、ルートクラウドのクレデンシャル機能を動的に決定しようとしてはならず、指定されたモードで実行する必要があることを CCO に通知できます。また、必要に応じて、Operator を "手動" モードにすることもできます。フィールドをデフォルトモードのままにすると、CCO が実行され、クラスターのクラウドクレデンシャルが (サポートされているクラウド/プラットフォームで) 機能に対して動的にプローブされます。サポートされているモード: AWS/Azure/GCP の場合は、"" (デフォルト)、"Mint"、"Passthrough"、"Manual" です。その他のプラットフォームでは、"Passthrough" での実行のみがサポートされているため、値を設定しないでください。 |
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
3.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- CloudCredentialStatus は、cloud-credential-operator の監視ステータスを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
3.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
3.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
3.1.5. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
3.1.6. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- CloudCredential のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が CloudCredential のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- CloudCredential を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
3.2.2. /apis/operator.openshift.io/v1/cloudcredentials/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| CloudCredential の名前 |
- HTTP メソッド
-
DELETE - 説明
- CloudCredential を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された CloudCredential を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された CloudCredential を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された CloudCredential を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
3.2.3. /apis/operator.openshift.io/v1/cloudcredentials/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| CloudCredential の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された CloudCredential のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された CloudCredential のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された CloudCredential のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第4章 ClusterCSIDriver [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ClusterCSIDriver オブジェクトを使用すると、OpenShift にデフォルトでインストールされている CSI ドライバー Operator の管理と設定が可能になります。オブジェクトの名前は、それが動作する CSI ドライバーの名前である必要があります。許可される値のリストは、CSIDriverName タイプを参照してください。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
4.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 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
4.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| driverConfig は、プラットフォーム固有のドライバー設定を指定するために使用できます。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。これらのデフォルトは時間の経過とともに変更される可能性があります。 |
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| storageClassState は、CSI Operator がストレージクラスを作成および管理する必要があるかどうかを決定します。このフィールドの値が空または Managed の場合、CSI Operator はストレージクラスを継続的に調整し、必要に応じて作成します。このフィールドの値が Unmanaged の場合、CSI Operator は以前に作成されたストレージクラスを調整しません。このフィールド値が Removed の場合、CSI Operator は以前に作成したストレージクラスを削除します。省略すると、ユーザーによる指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトの動作は Managed です。 |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
4.1.2. .spec.driverConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- driverConfig は、プラットフォーム固有のドライバー設定を指定するために使用できます。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。これらのデフォルトは時間の経過とともに変更される可能性があります。
- 型
-
object - 必須
-
driverType
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| aws は、AWS の CSI ドライバーを設定するために使用します。 |
|
|
| azure は、Azure の CSI ドライバーを設定するために使用します。 |
|
|
| driverType は、driverConfig が適用される CSI ドライバーのタイプを示します。有効な値は、AWS、Azure、GCP、IBMCloud、vSphere です (省略可能)。不明な値は、コンシューマーによって NO-OP として扱われます。 |
|
|
| gcp は、GCP の CSI ドライバーを設定するために使用します。 |
|
|
| ibmcloud は、IBM の Cloud CSI ドライバーを設定するために使用します。 |
|
|
| vSphere は、vsphere の CSI ドライバーを設定するために使用します。 |
4.1.3. .spec.driverConfig.aws リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- aws は、AWS の CSI ドライバーを設定するために使用します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| efsVolumeMetrics は、EFS CSI Driver によって使用される、EFS ボリュームからメトリクスを収集するための設定を指定します。 |
|
|
| kmsKeyARN は、AWS が使用するデフォルトの KMS キーではなく、ユーザー定義の KMS キーを使用してボリュームを暗号化するようにクラスターのデフォルトストレージクラスを設定します。値は、KMS キーの ARN または Alias ARN のいずれかです。 |
4.1.4. .spec.driverConfig.aws.efsVolumeMetrics リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- efsVolumeMetrics は、EFS CSI Driver によって使用される、EFS ボリュームからメトリクスを収集するための設定を指定します。
- 型
-
object - 必須
-
state
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| recursiveWalk は、state が RecursiveWalk に設定されている場合に、AWS EFS CSI Driver でのボリュームメトリクス収集に関する追加設定を提供します。 |
|
|
| state は、AWS EFS CSI Driver のメトリクス収集の状態を定義します。このフィールドは必須であり、Disabled または RecursiveWalk のいずれかの値に設定する必要があります。Disabled にすると、メトリクス収集は実行されません。これはデフォルト値です。RecursiveWalk にすると、AWS EFS CSI Driver がボリュームを再帰的にスキャンしてメトリクスを収集します。このプロセスにより、ボリュームサイズに応じて CPU とメモリーの使用率が高くなる可能性があります。 |
4.1.5. .spec.driverConfig.aws.efsVolumeMetrics.recursiveWalk リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- recursiveWalk は、state が RecursiveWalk に設定されている場合に、AWS EFS CSI Driver でのボリュームメトリクス収集に関する追加設定を提供します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| fsRateLimit は、ボリュームメトリクスを処理する際のレート制限を、ファイルシステムごとの goroutine で定義します。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトは 5 です。有効な範囲は 1 - 100 goroutine です。 |
|
|
| refreshPeriodMinutes は、ボリュームメトリクスの更新頻度 (分単位) を指定します。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトは 240 です。有効な範囲は 1 - 43200 分 (30 日) です。 |
4.1.6. .spec.driverConfig.azure リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- azure は、Azure の CSI ドライバーを設定するために使用します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| diskEncryptionSet は、プラットフォームによって管理されるデフォルトの鍵ではなく、顧客が管理する暗号化セットを使用してボリュームを暗号化するようにクラスターのデフォルトのストレージクラスを設定します。 |
4.1.7. .spec.driverConfig.azure.diskEncryptionSet リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- diskEncryptionSet は、プラットフォームによって管理されるデフォルトの鍵ではなく、顧客が管理する暗号化セットを使用してボリュームを暗号化するようにクラスターのデフォルトのストレージクラスを設定します。
- 型
-
object - 必須
-
name -
resourceGroup -
subscriptionID
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、デフォルトのストレージクラスに設定されるディスク暗号化セットの名前です。値は、英数字、アンダースコア (_)、ハイフンのみで構成し、80 文字以下の長さにする必要があります。 |
|
|
| resourceGroup は、ディスク暗号化セットを含む Azure リソースグループを定義します。値は、英数字、アンダースコア (_)、括弧、ハイフン、ピリオドのみで構成する必要があります。末尾をピリオド以外の文字にして、90 文字以下の長さにする必要があります。 |
|
|
| subscriptionID は、ディスク暗号化セットを含む Azure サブスクリプションを定義します。値は次の条件を満たす必要があります。1.128 ビットの数値である必要があります。2. 36 文字 (16 進数の 32 文字とハイフン 4 文字) の長さにする必要があります。3. ハイフン (-) で区切られた 5 つのグループで表す必要があります。4. 最初のグループは 8 文字の長さにする必要があります。5. 2 番目、3 番目、4 番目のグループは 4 文字の長さにする必要があります。6. 5 番目のグループは 12 文字の長さにする必要があります。SubscrionID の例: f2007bbf-f802-4a47-9336-cf7c6b89b378 |
4.1.8. .spec.driverConfig.gcp リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- gcp は、GCP の CSI ドライバーを設定するために使用します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| kmsKey は、GCP によって管理されるデフォルトの鍵ではなく、顧客が提供する暗号鍵を使用してボリュームを暗号化するようにクラスターのデフォルトのストレージクラスを設定します。 |
4.1.9. .spec.driverConfig.gcp.kmsKey リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- kmsKey は、GCP によって管理されるデフォルトの鍵ではなく、顧客が提供する暗号鍵を使用してボリュームを暗号化するようにクラスターのデフォルトのストレージクラスを設定します。
- 型
-
object - 必須
-
keyRing -
name -
projectID
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| keyRing は、KMS キーが属する KMS キーリングの名前です。値は、既存の KMS キーリングに対応し、英数字、ハイフン (-)、アンダースコア (_) のみで構成され、63 文字以下の長さである必要があります。 |
|
|
| location は、キーリングが存在する GCP の場所です。値は、既存の GCP の場所、つまり "global" と一致する必要があります。設定されていない場合、デフォルトで global になります。 |
|
|
| name は、ディスク暗号化に使用する顧客管理の暗号鍵の名前です。値は、既存の KMS キーに対応し、英数字、ハイフン (-)、アンダースコア (_) のみで構成され、63 文字以下の長さである必要があります。 |
|
|
| projectID は、KMS キーリングが存在するプロジェクトの ID です。6 - 30 文字の小文字、数字、またはハイフンにする必要があります。先頭は文字である必要があります。末尾にハイフンを使用しないでください。 |
4.1.10. .spec.driverConfig.ibmcloud リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ibmcloud は、IBM の Cloud CSI ドライバーを設定するために使用します。
- 型
-
object - 必須
-
encryptionKeyCRN
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| encryptionKeyCRN は、デフォルトストレージクラスのボリュームのディスク暗号化に使用する顧客管理のルートキーの IBM Cloud CRN です。 |
4.1.11. .spec.driverConfig.vSphere リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- vSphere は、vsphere の CSI ドライバーを設定するために使用します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| globalMaxSnapshotsPerBlockVolume は、あらゆる種類のデータストアのボリュームに適用されるグローバル設定パラメーターです。省略すると、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトは 3 です。このパラメーターを使用してスナップショットを無効にすることはできません。スナップショットの数を 3 以上に増やすと、パフォーマンスに悪影響が生じる可能性があります。詳細は、https://kb.vmware.com/s/article/1025279 を参照してください。ボリュームスナップショットに関するドキュメント: https://docs.vmware.com/en/VMware-vSphere-Container-Storage-Plug-in/3.0/vmware-vsphere-csp-getting-started/GUID-E0B41C69-7EEB-450F-A73D-5FD2FF39E891.html |
|
|
| granularMaxSnapshotsPerBlockVolumeInVSAN は、vSAN データストア専用の詳細な設定パラメーターです。設定されている場合、GlobalMaxSnapshotsPerBlockVolume がオーバーライドされます。設定されていない場合、グローバル制約にフォールバックします。このパラメーターを使用して VSAN のスナップショットを無効にすることはできません。 |
|
|
| granularMaxSnapshotsPerBlockVolumeInVVOL は、Virtual Volumes データストア専用の詳細な設定パラメーターです。設定されている場合、GlobalMaxSnapshotsPerBlockVolume がオーバーライドされます。設定されていない場合、グローバル制約にフォールバックします。このパラメーターを使用して VVOL のスナップショットを無効にすることはできません。 |
|
|
| topologyCategories は、hostcluster や datacenter などの vcenter リソースへのタグ付けに使用されるタグカテゴリーを示します。クラスターのインフラストラクチャーオブジェクトにトポロジーがある場合、インフラストラクチャーオブジェクトで指定されている値が使用され、topologyCategories への変更が拒否されます。 |
4.1.12. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
4.1.13. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
4.1.14. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
4.1.15. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
4.1.16. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- ClusterCSIDriver のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ClusterCSIDriver のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ClusterCSIDriver を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
4.2.2. /apis/operator.openshift.io/v1/clustercsidrivers/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterCSIDriver の名前 |
- HTTP メソッド
-
DELETE - 説明
- ClusterCSIDriver を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterCSIDriver を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterCSIDriver を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterCSIDriver を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
4.2.3. /apis/operator.openshift.io/v1/clustercsidrivers/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterCSIDriver の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterCSIDriver のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterCSIDriver のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterCSIDriver のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第5章 Console [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
コンソールは、コンソールを管理するように Operator を設定する手段を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
5.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 | |
|
|
| ConsoleSpec は、コンソールの望ましい動作の仕様です。 |
|
|
| ConsoleStatus は、コンソールの監視ステータスを定義します。 |
5.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConsoleSpec は、コンソールの望ましい動作の仕様です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| customization は、必要に応じて少数のカスタマイズオプションを Web コンソールに提供するために使用します。 |
|
|
| ingress を使用すると、コンソールの代替 Ingress を設定できます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターを対象としています。 |
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| plugins は、有効なコンソールプラグイン名のリストを定義します。 |
|
|
| プロバイダーには、特定のサービスプロバイダーを使用するための設定が含まれています。 |
|
|
| ルートには、サービング証明書を含むホスト名とシークレット参照が含まれています。カスタムルートが指定されている場合、指定されたホスト名で新しいルートが作成され、その下でコンソールを使用できます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。カスタムホスト名が任意のドメインを指している場合は、手動の DNS 設定手順が必要です。カスタムルートが削除された場合、コンソールのデフォルトのホスト名を予約するために、デフォルトのコンソールルートが維持されます。指定しない場合、デフォルトルートが使用されます。非推奨 |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
5.1.2. .spec.customization リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- customization は、必要に応じて少数のカスタマイズオプションを Web コンソールに提供するために使用します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| addPage を使用すると、開発者の観点から追加ページのアクションをカスタマイズできます。 |
|
|
| ブランドは Web コンソールのデフォルトのブランドであり、ブランドフィールドを指定することでオーバーライドできます。特定のブランドオプションの限られたセットがあります。このフィールドは、ロゴなどのコンソールの要素を制御します。値が無効な場合、コンソールのロールアウトが妨げられます。 |
|
|
| capabilities は、コンソール UI で操作できる機能の配列を定義します。各機能には、コンソールで操作して UI にレンダリングできる視覚的な状態を定義します。使用可能な機能は、LightspeedButton と GettingStartedBanner です。使用可能な機能は、それぞれリスト内に 1 つだけ指定できます。 |
|
|
| Capabilities には、コンソール UI の UI 機能のセットとその状態を含めます。 |
|
|
| customLogoFile は、マストヘッドおよび About ダイアログのデフォルトの OpenShift ロゴを置き換えます。これは、customLogoFile と logos は、同時にどちらか 1 つしか設定できないという点を参照しています。openshift-config namespace 内の ConfigMap。これは、'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' のようなコマンドで作成できます。ConfigMap サイズの制約により、イメージサイズは 1MB 未満である必要があります。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。ロゴの推奨ファイル形式は SVG ですが、ブラウザーでサポートされている場合は他のファイル形式も使用できます。非推奨: 代わりに logos を使用してください。 |
|
|
| customProductName は、通常の OpenShift 製品名の代わりに、ページタイトル、ロゴの代替テキスト、およびバージョン情報ダイアログに表示される名前です。 |
|
|
| developerCatalog を使用すると、表示する開発者カタログのカテゴリー (フィルター) とタイプ (サブカタログ) を設定できます。 |
|
|
| 外部ドキュメントへの documentationBaseURL リンクは、Web コンソールのさまざまなセクションに表示されます。documentationBaseURL を指定すると、デフォルトのドキュメント URL がオーバーライドされます。値が無効な場合、コンソールのロールアウトが妨げられます。 |
|
|
| logos は、コンソール UI の OpenShift マストヘッドロゴおよびファビコンロゴを、カスタムロゴに置き換えるために使用されます。logos はオプションのフィールドで、ロゴのリストを指定できます。customLogoFile と logos は、同時にどちらか 1 つしか設定できません。logos が設定されている場合は、customLogoFile を設定解除する必要があります。指定されている場合は、エントリーは少なくとも 1 つ、最大 2 つである必要があります。各タイプはリスト内に 1 回だけ出現する必要があります。 |
|
|
| logo は、コンソール UI ロゴのテーマモードに基づいて設定を定義します。 |
|
|
| perspectives を使用すると、ユーザーがパースペクティブスイッチャードロップダウンで表示できるパースペクティブを有効/無効にすることができます。 |
|
|
| Perspective は、クラスター管理者が表示/非表示にする必要があるパースペクティブスイッチャードロップダウンのパースペクティブを定義します。 |
|
|
| projectAccess を使用すると、開発者パースペクティブのプロジェクトアクセスページで利用可能な ClusterRoles のリストをカスタマイズできます。このページは、プロジェクト管理者が他のユーザーにロールを指定したり、プロジェクト内のアクセスを制限したりするために使用できます。設定されている場合、リストはデフォルトの ClusterRole オプションに置き換わります。 |
|
|
| quickStarts を使用すると、コンソールで使用可能な ConsoleQuickStart リソースをカスタマイズできます。 |
5.1.3. .spec.customization.addPage リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- addPage を使用すると、開発者の観点から追加ページのアクションをカスタマイズできます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| disabledActions は、ユーザーに表示されないアクションのリストです。リスト内の各アクションは、その ID で表されます。 |
5.1.4. .spec.customization.capabilities リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- capabilities は、コンソール UI で操作できる機能の配列を定義します。各機能には、コンソールで操作して UI にレンダリングできる視覚的な状態を定義します。使用可能な機能は、LightspeedButton と GettingStartedBanner です。使用可能な機能は、それぞれリスト内に 1 つだけ指定できます。
- 型
-
array
5.1.5. .spec.customization.capabilities[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Capabilities には、コンソール UI の UI 機能のセットとその状態を含めます。
- 型
-
object - 必須
-
name -
visibility
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、機能の一意の名前です。使用可能な機能は、LightspeedButton と GettingStartedBanner です。 |
|
|
| visibility は、機能の表示状態を定義します。 |
5.1.6. .spec.customization.capabilities[].visibility リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- visibility は、機能の表示状態を定義します。
- 型
-
object - 必須
-
state
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| state は、コンソール UI で機能を有効にするか無効にするかを定義します。コンソール UI で機能を有効にするには、"Enabled" 値を指定します。コンソール UI で機能を無効にするには、"Disabled" 値を指定します。 |
5.1.7. .spec.customization.customLogoFile リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- customLogoFile は、マストヘッドおよび About ダイアログのデフォルトの OpenShift ロゴを置き換えます。これは、customLogoFile と logos は、同時にどちらか 1 つしか設定できないという点を参照しています。openshift-config namespace 内の ConfigMap。これは、'oc create configmap custom-logo --from-file=/path/to/file -n openshift-config' のようなコマンドで作成できます。ConfigMap サイズの制約により、イメージサイズは 1MB 未満である必要があります。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。ロゴの推奨ファイル形式は SVG ですが、ブラウザーでサポートされている場合は他のファイル形式も使用できます。非推奨: 代わりに logos を使用してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key を使用すると、設定マップ内の特定のキー/値を指すことができます。これは、論理ファイルの参照に役立ちます。 |
|
|
|
5.1.8. .spec.customization.developerCatalog リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- developerCatalog を使用すると、表示する開発者カタログのカテゴリー (フィルター) とタイプ (サブカタログ) を設定できます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 開発者カタログに表示されているカテゴリー。 |
|
|
| 開発者コンソールカタログの DeveloperConsoleCatalogCategory。 |
|
|
| types を使用すると、開発者カタログでユーザーが表示できるサブカタログタイプを有効または無効にすることができます。省略すると、すべてのサブカタログタイプが表示されます。 |
5.1.9. .spec.customization.developerCatalog.categories リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 開発者カタログに表示されているカテゴリー。
- 型
-
array
5.1.10. .spec.customization.developerCatalog.categories[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 開発者コンソールカタログの DeveloperConsoleCatalogCategory。
- 型
-
object - 必須
-
id -
label
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| id は、コンソールでディープリンクを有効にするために URL で使用される識別子です。ID は必須です。また、URL セーフな文字 (A-Z、a-z、0-9、-、_) を 1-32 文字使用する必要があります。 |
|
|
| label は、カテゴリー表示ラベルを定義します。必須であり、1〜64 文字である必要があります。 |
|
|
| サブカテゴリーは、子カテゴリーのリストを定義します。 |
|
|
| DeveloperConsoleCatalogCategoryMeta は、開発者カタログカテゴリーの主要な識別子です。 |
|
|
| タグは、カテゴリーに一致する文字列のリストです。選択したカテゴリーには、カテゴリーとアイテムの間に少なくとも 1 つの重複するタグがあるすべてのアイテムが表示されます。 |
5.1.11. .spec.customization.developerCatalog.categories[].subcategories リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- サブカテゴリーは、子カテゴリーのリストを定義します。
- 型
-
array
5.1.12. .spec.customization.developerCatalog.categories[].subcategories[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- DeveloperConsoleCatalogCategoryMeta は、開発者カタログカテゴリーの主要な識別子です。
- 型
-
object - 必須
-
id -
label
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| id は、コンソールでディープリンクを有効にするために URL で使用される識別子です。ID は必須です。また、URL セーフな文字 (A-Z、a-z、0-9、-、_) を 1-32 文字使用する必要があります。 |
|
|
| label は、カテゴリー表示ラベルを定義します。必須であり、1〜64 文字である必要があります。 |
|
|
| タグは、カテゴリーに一致する文字列のリストです。選択したカテゴリーには、カテゴリーとアイテムの間に少なくとも 1 つの重複するタグがあるすべてのアイテムが表示されます。 |
5.1.13. .spec.customization.developerCatalog.types リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- types を使用すると、開発者カタログでユーザーが表示できるサブカタログタイプを有効または無効にすることができます。省略すると、すべてのサブカタログタイプが表示されます。
- 型
-
object - 必須
-
state
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| disabled は、ユーザーに表示されない開発者カタログのタイプ (サブカタログ ID) のリストです。タイプ (サブカタログ) は、コンソールプラグインを介して追加されます。使用可能なタイプ (サブカタログ ID) は、コンソールのクラスター設定ページ、またはコンソールで YAML を編集するときに使用できます。たとえば、"Devfile"、"HelmChart"、"BuilderImage" です。リストが空の場合、または使用可能なサブカタログタイプがすべて追加されている場合は、開発者カタログ全体が非表示になります。 |
|
|
| enabled は、ユーザーに表示される開発者カタログのタイプ (サブカタログ ID) のリストです。タイプ (サブカタログ) は、コンソールプラグインを介して追加されます。使用可能なタイプ (サブカタログ ID) は、コンソールのクラスター設定ページ、またはコンソールで YAML を編集するときに使用できます。たとえば、"Devfile"、"HelmChart"、"BuilderImage" です。リストが空でない場合、新しいタイプはリストに追加されるまでユーザーに表示されません。リストが空の場合、開発者カタログ全体が表示されます。 |
|
|
| state は、カタログタイプのリストを有効にするか無効にするかを定義します。 |
5.1.14. .spec.customization.logos リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- logos は、コンソール UI の OpenShift マストヘッドロゴおよびファビコンロゴを、カスタムロゴに置き換えるために使用されます。logos はオプションのフィールドで、ロゴのリストを指定できます。customLogoFile と logos は、同時にどちらか 1 つしか設定できません。logos が設定されている場合は、customLogoFile を設定解除する必要があります。指定されている場合は、エントリーは少なくとも 1 つ、最大 2 つである必要があります。各タイプはリスト内に 1 回だけ出現する必要があります。
- 型
-
array
5.1.15. .spec.customization.logos[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- logo は、コンソール UI ロゴのテーマモードに基づいて設定を定義します。
- 型
-
object - 必須
-
themes -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| themes は、コンソール UI ロゴのテーマを指定します。themes は必須フィールドで、テーマのリストを指定できます。テーマリスト内の各項目には、一意のモードとソースフィールドが必要です。各モードによって、コンソール UI のロゴがダークモード用かライトモード用かが決まります。テーマが指定されていない場合、そのテーマにはデフォルトの OpenShift ロゴが表示されます。エントリーは少なくとも 1 つ、最大 2 つである必要があります。 |
|
|
| テーマは、コンソール UI のテーマモードを定義します。 |
|
|
| type は、コンソール UI のロゴのタイプを指定します。ロゴがマストヘッド用かファビコン用かを決定します。type は必須フィールドで、マストヘッドとファビコンの値を入力できます。"Masthead" に設定すると、ロゴはコンソール UI のマストヘッドと About モーダルで使用されます。"Favicon" に設定すると、そのロゴがコンソール UI のファビコンとして使用されます。 |
5.1.16. .spec.customization.logos[].themes リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- themes は、コンソール UI ロゴのテーマを指定します。themes は必須フィールドで、テーマのリストを指定できます。テーマリスト内の各項目には、一意のモードとソースフィールドが必要です。各モードによって、コンソール UI のロゴがダークモード用かライトモード用かが決まります。テーマが指定されていない場合、そのテーマにはデフォルトの OpenShift ロゴが表示されます。エントリーは少なくとも 1 つ、最大 2 つである必要があります。
- 型
-
array
5.1.17. .spec.customization.logos[].themes[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- テーマは、コンソール UI のテーマモードを定義します。
- 型
-
object - 必須
-
mode -
source
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| mode は、コンソール UI でロゴが適用するテーマモードを指定するために使用されます。mode は必須フィールドで、ダークとライトの値を指定できます。Dark に設定すると、コンソール UI のエンドユーザーが Dark モードを有効化した場合に、'file' フィールドで参照されるロゴファイルが使用されます。Light に設定すると、コンソール UI のエンドユーザーが Light モードを有効化した場合に、'file' フィールドで参照されるロゴファイルが使用されます。 |
|
|
| source は、コンソールによって、カスタムロゴを含む指定されたファイルを見つけるために使用されます。source は、openshift-config namespace 内のカスタムロゴファイルを含む ConfigMap 名とキーを参照する必須フィールドです。'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file' のようなコマンドで作成できます。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。マストヘッドロゴとファビコンロゴに推奨されるファイル形式は SVG ですが、ブラウザーでサポートされている場合は他のファイル形式も使用できます。ConfigMap サイズの制約により、ロゴイメージサイズは 1MB 未満である必要があります。詳細は、https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console のドキュメントを参照してください。 |
5.1.18. .spec.customization.logos[].themes[].source リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- source は、コンソールによって、カスタムロゴを含む指定されたファイルを見つけるために使用されます。source は、openshift-config namespace 内のカスタムロゴファイルを含む ConfigMap 名とキーを参照する必須フィールドです。'oc create configmap custom-logos-config --namespace=openshift-config --from-file=/path/to/file' のようなコマンドで作成できます。コンソールが正しい MIME タイプでファイルを提供できるように、ConfigMap キーにはファイル拡張子を含める必要があります。マストヘッドロゴとファビコンロゴに推奨されるファイル形式は SVG ですが、ブラウザーでサポートされている場合は他のファイル形式も使用できます。ConfigMap サイズの制約により、ロゴイメージサイズは 1MB 未満である必要があります。詳細は、https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/web_console/customizing-web-console#customizing-web-console のドキュメントを参照してください。
- 型
-
object - 必須
-
from
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| configMap は、ソースとして使用する ConfigMap の詳細 (ConfigMap の名前やファイルに対応するキーなど) を指定します。その ConfigMap は、openshift-config namespace に存在する必要があります。from が "ConfigMap" の場合に必須となり、それ以外の場合は指定できません。 |
|
|
| from は必須フィールドで、ファイル参照のソースタイプを指定します。許可される値は ConfigMap です。ConfigMap に設定すると、ファイルは openshift-config namespace の ConfigMap から取得されます。from が ConfigMap に設定されている場合は、configMap フィールドを設定する必要があります。 |
5.1.19. .spec.customization.logos[].themes[].source.configMap リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- configMap は、ソースとして使用する ConfigMap の詳細 (ConfigMap の名前やファイルに対応するキーなど) を指定します。その ConfigMap は、openshift-config namespace に存在する必要があります。from が "ConfigMap" の場合に必須となり、それ以外の場合は指定できません。
- 型
-
object - 必須
-
key -
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は参照される ConfigMap 内のロゴキーです。英数字、ダッシュ (-)、アンダースコア (_)、ピリオド (.) のみで構成する必要があります。最大長は 253 文字にする必要があります。有効なファイル拡張子で終わる必要があります。有効なファイル拡張子は、ピリオドとそれに続く 2 - 5 文字の英字で構成される必要があります。 |
|
|
| name は ConfigMap の名前です。name は必須フィールドです。小文字の英数字、'-'、または '.' が含まれ、先頭と末尾は英数字にする必要があります。最大長は 253 文字にする必要があります。 |
5.1.20. .spec.customization.perspectives リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- perspectives を使用すると、ユーザーがパースペクティブスイッチャードロップダウンで表示できるパースペクティブを有効/無効にすることができます。
- 型
-
array
5.1.21. .spec.customization.perspectives[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Perspective は、クラスター管理者が表示/非表示にする必要があるパースペクティブスイッチャードロップダウンのパースペクティブを定義します。
- 型
-
object - 必須
-
id -
visibility
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| id は、パースペクティブの ID を定義します。たとえば、"dev"、"admin" です。利用可能なパースペクティブ ID は、yaml エディターの横にあるコードスニペットセクションにあります。不正確または不明な ID は無視されます。 |
|
|
|
pinnedResources は、ユーザーが固定されたリソースを自分でカスタマイズしていない場合に、パースペクティブナビゲーションでユーザーに表示されるデフォルトの固定されたリソースのリストを定義します。利用可能な Kubernetes リソースのリストは、 |
|
|
| PinnedResourceReference には、リソースのグループ、バージョン、タイプを含めます。 |
|
|
| visibility は、パースペクティブの状態と、アクセスレビューチェック (そのパースペクティブに必要な場合) を定義します。 |
5.1.22. .spec.customization.perspectives[].pinnedResources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
pinnedResources は、ユーザーが固定されたリソースを自分でカスタマイズしていない場合に、パースペクティブナビゲーションでユーザーに表示されるデフォルトの固定されたリソースのリストを定義します。利用可能な Kubernetes リソースのリストは、
kubectl api-resourcesを介して読み取ることができます。また、コンソールが提供する設定 UI と YAML スニペットに、ナビゲーションに固定できる利用可能なリソースがリスト表示されます。不正確または不明なリソースは無視されます。 - 型
-
array
5.1.23. .spec.customization.perspectives[].pinnedResources[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PinnedResourceReference には、リソースのグループ、バージョン、タイプを含めます。
- 型
-
object - 必須
-
group -
resource -
version
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は、リソースの API グループです。コアグループの場合は、空の文字列を入力します。この値は、小文字の英数字、ハイフン、ピリオドのみで構成する必要があります。たとえば、""、"apps"、"build.openshift.io" です。 |
|
|
| resource は、参照されるタイプです。通常、リソースの種類の複数形を小文字で表記したものです。この値は、小文字の英数字とハイフンのみで構成する必要があります。たとえば、"deployments"、"deploymentconfigs"、"pods" です。 |
|
|
| version は、リソースの API バージョンです。この値は小文字の英数字のみで構成する必要があります。たとえば、"v1"、"v1beta1" です。 |
5.1.24. .spec.customization.perspectives[].visibility リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- visibility は、パースペクティブの状態と、アクセスレビューチェック (そのパースペクティブに必要な場合) を定義します。
- 型
-
object - 必須
-
state
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| accessReview は、必要なアクセスレビューチェックと不足しているアクセスレビューチェックを定義します。 |
|
|
| state は、パースペクティブが有効か無効か、またはアクセスレビューチェックが必要かどうかを定義します。 |
5.1.25. .spec.customization.perspectives[].visibility.accessReview リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- accessReview は、必要なアクセスレビューチェックと不足しているアクセスレビューチェックを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| missing は、権限チェックのリストを定義します。1 つ以上のチェックが失敗した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、必要なアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。 |
|
|
| ResourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる認可属性が含まれています |
|
|
| required は、権限チェックのリストを定義します。すべてのチェックが成功した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、不足しているアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。 |
|
|
| ResourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる認可属性が含まれています |
5.1.26. .spec.customization.perspectives[].visibility.accessReview.missing リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- missing は、権限チェックのリストを定義します。1 つ以上のチェックが失敗した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、必要なアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。
- 型
-
array
5.1.27. .spec.customization.perspectives[].visibility.accessReview.missing[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ResourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる認可属性が含まれています
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| fieldSelector は、フィールドに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、 |
|
|
| group は、リソースの API グループです。"*" はすべてを意味します。 |
|
|
| labelSelector は、ラベルに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、 |
|
|
| name は、"取得" のためにリクエストされているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。 |
|
|
| namespace は、リクエストされているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。 |
|
|
| resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。 |
|
|
| subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。 |
|
|
| verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。 |
|
|
| version は、リソースの API バージョンです。"*" はすべてを意味します。 |
5.1.28. .spec.customization.perspectives[].visibility.accessReview.missing[].fieldSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
fieldSelector は、フィールドに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、
AuthorizeWithSelectorsフィーチャーゲートを有効にする必要があります (デフォルトでは無効)。- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| rawSelector は、クエリーパラメーターに含まれるフィールドセレクターのシリアル化です。Webhook 実装では、rawSelector を無視することが推奨されます。kube-apiserver の *SubjectAccessReview は、requirements が存在しない限り、rawSelector を解析します。 |
|
|
| requirements は、フィールドセレクターの解析された解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。 |
|
|
| FieldSelectorRequirement は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
5.1.29. .spec.customization.perspectives[].visibility.accessReview.missing[].fieldSelector.requirements リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- requirements は、フィールドセレクターの解析された解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。
- 型
-
array
5.1.30. .spec.customization.perspectives[].visibility.accessReview.missing[].fieldSelector.requirements[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- FieldSelectorRequirement は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、要件が適用されるフィールドセレクターキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Operator のリストは、今後増える可能性があります。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。 |
5.1.31. .spec.customization.perspectives[].visibility.accessReview.missing[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
labelSelector は、ラベルに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、
AuthorizeWithSelectorsフィーチャーゲートを有効にする必要があります (デフォルトでは無効)。- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| rawSelector は、クエリーパラメーターに含まれるフィールドセレクターのシリアル化です。Webhook 実装では、rawSelector を無視することが推奨されます。kube-apiserver の *SubjectAccessReview は、requirements が存在しない限り、rawSelector を解析します。 |
|
|
| requirements は、ラベルセレクターを解析した結果の解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
5.1.32. .spec.customization.perspectives[].visibility.accessReview.missing[].labelSelector.requirements リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- requirements は、ラベルセレクターを解析した結果の解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。
- 型
-
array
5.1.33. .spec.customization.perspectives[].visibility.accessReview.missing[].labelSelector.requirements[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
5.1.34. .spec.customization.perspectives[].visibility.accessReview.required リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- required は、権限チェックのリストを定義します。すべてのチェックが成功した場合にのみ、パースペクティブが表示されます。省略すると、アクセスレビューがスキップされ、不足しているアクセスレビューのリストの設定によって要求されない限り、パースペクティブは表示されません。
- 型
-
array
5.1.35. .spec.customization.perspectives[].visibility.accessReview.required[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ResourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる認可属性が含まれています
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| fieldSelector は、フィールドに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、 |
|
|
| group は、リソースの API グループです。"*" はすべてを意味します。 |
|
|
| labelSelector は、ラベルに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、 |
|
|
| name は、"取得" のためにリクエストされているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。 |
|
|
| namespace は、リクエストされているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。 |
|
|
| resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。 |
|
|
| subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。 |
|
|
| verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。 |
|
|
| version は、リソースの API バージョンです。"*" はすべてを意味します。 |
5.1.36. .spec.customization.perspectives[].visibility.accessReview.required[].fieldSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
fieldSelector は、フィールドに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、
AuthorizeWithSelectorsフィーチャーゲートを有効にする必要があります (デフォルトでは無効)。- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| rawSelector は、クエリーパラメーターに含まれるフィールドセレクターのシリアル化です。Webhook 実装では、rawSelector を無視することが推奨されます。kube-apiserver の *SubjectAccessReview は、requirements が存在しない限り、rawSelector を解析します。 |
|
|
| requirements は、フィールドセレクターの解析された解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。 |
|
|
| FieldSelectorRequirement は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
5.1.37. .spec.customization.perspectives[].visibility.accessReview.required[].fieldSelector.requirements リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- requirements は、フィールドセレクターの解析された解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。
- 型
-
array
5.1.38. .spec.customization.perspectives[].visibility.accessReview.required[].fieldSelector.requirements[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- FieldSelectorRequirement は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、要件が適用されるフィールドセレクターキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Operator のリストは、今後増える可能性があります。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。 |
5.1.39. .spec.customization.perspectives[].visibility.accessReview.required[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
labelSelector は、ラベルに基づくアクセスの制限を記述します。アクセスを制限することはできますが、拡大することはできません。
このフィールドはアルファレベルです。このフィールドを使用するには、
AuthorizeWithSelectorsフィーチャーゲートを有効にする必要があります (デフォルトでは無効)。- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| rawSelector は、クエリーパラメーターに含まれるフィールドセレクターのシリアル化です。Webhook 実装では、rawSelector を無視することが推奨されます。kube-apiserver の *SubjectAccessReview は、requirements が存在しない限り、rawSelector を解析します。 |
|
|
| requirements は、ラベルセレクターを解析した結果の解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
5.1.40. .spec.customization.perspectives[].visibility.accessReview.required[].labelSelector.requirements リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- requirements は、ラベルセレクターを解析した結果の解釈です。リソースインスタンスがセレクターと一致するためには、requirements に含まれるすべての条件が適用される必要があります。Webhook 実装は要件を処理する必要がありますが、それをどのように処理するかは Webhook 次第です。Requirements はリクエストを制限する役割しか持たないため、内容が理解できない場合は、無制限のリクエストとして許可しても問題ありません。
- 型
-
array
5.1.41. .spec.customization.perspectives[].visibility.accessReview.required[].labelSelector.requirements[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
5.1.42. .spec.customization.projectAccess リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- projectAccess を使用すると、開発者パースペクティブのプロジェクトアクセスページで利用可能な ClusterRoles のリストをカスタマイズできます。このページは、プロジェクト管理者が他のユーザーにロールを指定したり、プロジェクト内のアクセスを制限したりするために使用できます。設定されている場合、リストはデフォルトの ClusterRole オプションに置き換わります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| availableClusterRoles は、プロジェクトアクセスタブを介してユーザーに割り当てることができる ClusterRole 名のリストです。 |
5.1.43. .spec.customization.quickStarts リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- quickStarts を使用すると、コンソールで使用可能な ConsoleQuickStart リソースをカスタマイズできます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 無効は、ユーザーに表示されない ConsoleQuickStart リソース名のリストです。 |
5.1.44. .spec.ingress リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ingress を使用すると、コンソールの代替 Ingress を設定できます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターを対象としています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| clientDownloadsURL は、クライアントバイナリーをダウンロードするためのアドレスとして使用される URL です。指定されていない場合、ダウンロードルートのホスト名が使用されます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターに必要です。この URL はコンソール Operator によって監視されます。URL に長期間アクセスできない場合、コンソール Operator がデグレード状態になる可能性があります。HTTPS スキームを使用する必要があります。 |
|
|
| consoleURL は、ベースコンソールアドレスとして使用される URL です。指定されていない場合、コンソールルートのホスト名が使用されます。このフィールドは、Ingress 機能がなく、ルートにアクセスできないクラスターに必要です。この URL に適切な Ingress が設定されていることを確認してください。この URL はコンソール Operator によって監視されます。URL に長期間アクセスできない場合、コンソール Operator がデグレード状態になる可能性があります。HTTPS スキームを使用する必要があります。 |
5.1.45. .spec.providers リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- プロバイダーには、特定のサービスプロバイダーを使用するための設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| statuspage には、ステータス情報を提供する statuspage.io ページの ID が含まれています。 |
5.1.46. .spec.providers.statuspage リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- statuspage には、ステータス情報を提供する statuspage.io ページの ID が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| pageID は、Statuspage によってページに割り当てられた一意の ID です。これは公開ページである必要があります。 |
5.1.47. .spec.route リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ルートには、サービング証明書を含むホスト名とシークレット参照が含まれています。カスタムルートが指定されている場合、指定されたホスト名で新しいルートが作成され、その下でコンソールを使用できます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。カスタムホスト名が任意のドメインを指している場合は、手動の DNS 設定手順が必要です。カスタムルートが削除された場合、コンソールのデフォルトのホスト名を予約するために、デフォルトのコンソールルートが維持されます。指定しない場合、デフォルトルートが使用されます。非推奨
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ホスト名は、コンソールを使用できる目的のカスタムドメインです。 |
|
|
| secret は、カスタムの証明書と鍵が含まれる openshift-config namespace 内のシークレットを参照します。シークレットはクラスター管理者が手動で作成する必要があります。参照されるシークレットには、次のキー値のペアが含まれている必要があります。- "tls.crt" - カスタム証明書を指定します。- "tls.key" - カスタム証明書の秘密鍵を指定します。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット仕様は必要ありません。 |
5.1.48. .spec.route.secret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- secret は、カスタムの証明書と鍵が含まれる openshift-config namespace 内のシークレットを参照します。シークレットはクラスター管理者が手動で作成する必要があります。参照されるシークレットには、次のキー値のペアが含まれている必要があります。- "tls.crt" - カスタム証明書を指定します。- "tls.key" - カスタム証明書の秘密鍵を指定します。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット仕様は必要ありません。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
5.1.49. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConsoleStatus は、コンソールの監視ステータスを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
5.1.50. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
5.1.51. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
5.1.52. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
5.1.53. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- コンソールのコレクションを削除する
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Console のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- コンソールを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
5.2.2. /apis/operator.openshift.io/v1/consoles/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| コンソールの名前 |
- HTTP メソッド
-
DELETE - 説明
- コンソールを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたコンソールを読む
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたコンソールを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたコンソールを交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
5.2.3. /apis/operator.openshift.io/v1/consoles/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| コンソールの名前 |
- HTTP メソッド
-
GET - 説明
- 指定されたコンソールのステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたコンソールのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたコンソールのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第6章 Config [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Config は、クラスター上に他のコンポーネントの初期設定を作成する役割を担う config Operator の動作を指定します。この Operator は、AWS および Azure クラウドベースのクラスターのクラウド設定のインストール、移行、または同期も処理します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
6.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 | |
|
|
| spec は、Config Operator の望ましい動作の仕様です。 |
|
|
| status は、Config Operator の監視ステータスを定義します。 |
6.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、Config Operator の望ましい動作の仕様です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
6.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、Config Operator の監視ステータスを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
6.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
6.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
6.1.5. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
6.1.6. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- Config のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Config のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- 設定を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
6.2.2. /apis/operator.openshift.io/v1/configs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 設定の名前 |
- HTTP メソッド
-
DELETE - 説明
- 設定を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Config を読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された設定を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された設定を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
6.2.3. /apis/operator.openshift.io/v1/configs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 設定の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された設定のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された設定のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された設定のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第7章 Config [imageregistry.operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Config は、レジストリー Operator によって管理されるレジストリーインスタンスの設定オブジェクトです。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
metadata -
spec
-
7.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 | |
|
|
| ImageRegistrySpec は、実行中のレジストリーの仕様を定義します。 |
|
|
| ImageRegistryStatus は、イメージレジストリーの動作ステータスを報告します。 |
7.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageRegistrySpec は、実行中のレジストリーの仕様を定義します。
- 型
-
object - 必須
-
replicas
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| アフィニティーは、イメージレジストリー Pod のノードアフィニティースケジューリングルールのグループです。 |
|
|
| defaultRoute は、デフォルトで生成されたホスト名を使用して、レジストリーの外部向けルートを作成する必要があるかどうかを示します。 |
|
|
| disableRedirect は、バックエンドにリダイレクトするのではなく、レジストリーを介してすべてのデータをルーティングするかどうかを制御します。 |
|
|
| httpSecret は、レジストリーがアップロードを保護するために必要な値であり、デフォルトで生成されます。 |
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| ロギングは非推奨です。代わりに logLevel を使用してください。 |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
|
| nodeSelector は、レジストリー Pod のノード選択制約を定義します。 |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| proxy は、マスター API、アップストリームレジストリーなどを呼び出すときに使用されるプロキシーを定義します。 |
|
|
| readOnly は、レジストリーインスタンスが新しいイメージのプッシュや既存のイメージの削除を拒否するかどうかを指定します。 |
|
|
| レプリカは、実行するレジストリーインスタンスの数を決定します。 |
|
|
| 指定されたレジストリーインスタンスが追加リソースをキューに入れる前に処理する並列リクエストの数を制御します。 |
|
|
| resources は、レジストリー Pod のリソースリクエストと制限を定義します。 |
|
|
| rolloutStrategy は、イメージレジストリーデプロイメントのロールアウト戦略を定義します。 |
|
|
| ルートは、レジストリー用に作成する必要がある追加の外部向けルートを定義します。 |
|
|
| ImageRegistryConfigRoute は、イメージレジストリーへの外部ルートアクセスに関する情報を保持します。 |
|
|
| レジストリーストレージを設定するためのストレージの詳細 (S3 バケット座標など)。 |
|
|
| tolerations は、レジストリー Pod の許容値を定義します。 |
|
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
|
|
| topologySpreadConstraints は、一致する Pod を特定のトポロジー内でどのように分散するかを指定します。 |
|
|
| topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。 |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
7.1.2. .spec.affinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- アフィニティーは、イメージレジストリー Pod のノードアフィニティースケジューリングルールのグループです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Pod のノードアフィニティースケジューリングルールを説明します。 |
|
|
| Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。 |
|
|
| Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。 |
7.1.3. .spec.affinity.nodeAffinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod のノードアフィニティースケジューリングルールを説明します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
|
| 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。 |
|
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 対応する重みに関連付けられたノードセレクター用語。 |
|
|
| 対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。 |
7.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 対応する重みに関連付けられたノードセレクター用語。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
7.1.7. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。
- 型
-
object - 必須
-
nodeSelectorTerms
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。ノードセレクター用語のリスト。用語は OR されています。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.18. .spec.affinity.podAffinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
|
| この 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
7.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object - 必須
-
topologyKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
7.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.36. .spec.affinity.podAntiAffinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
|
| このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
|
| この 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
7.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object - 必須
-
topologyKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
7.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.54. .spec.proxy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- proxy は、マスター API、アップストリームレジストリーなどを呼び出すときに使用されるプロキシーを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| http は、HTTP エンドポイントにアクセスするときにイメージレジストリーによって使用されるプロキシーを定義します。 |
|
|
| https は、HTTPS エンドポイントにアクセスするときにイメージレジストリーによって使用されるプロキシーを定義します。 |
|
|
| noProxy は、プロキシーを通過してはならないホスト名のコンマ区切りリストを定義します。 |
7.1.55. .spec.requests リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 指定されたレジストリーインスタンスが追加リソースをキューに入れる前に処理する並列リクエストの数を制御します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| read は、イメージレジストリーの読み取りの制限を定義します。 |
|
|
| write は、イメージレジストリーの書き込みの制限を定義します。 |
7.1.56. .spec.requests.read リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- read は、イメージレジストリーの読み取りの制限を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| maxInQueue は、キューに入れられた API リクエストの最大数をレジストリーに設定します。 |
|
|
| maxRunning は、飛行中の API リクエストの最大数をレジストリーに設定します。 |
|
|
| maxWaitInQueue は、リクエストが拒否される前にキューで待機できる最大時間を設定します。 |
7.1.57. .spec.requests.write リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- write は、イメージレジストリーの書き込みの制限を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| maxInQueue は、キューに入れられた API リクエストの最大数をレジストリーに設定します。 |
|
|
| maxRunning は、飛行中の API リクエストの最大数をレジストリーに設定します。 |
|
|
| maxWaitInQueue は、リクエストが拒否される前にキューで待機できる最大時間を設定します。 |
7.1.58. .spec.resources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- resources は、レジストリー Pod のリソースリクエストと制限を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。 これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。 このフィールドは変更不可能です。これはコンテナーにのみ設定できます。 |
|
|
| ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。 |
|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
7.1.59. .spec.resources.claims リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。
これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。
このフィールドは変更不可能です。これはコンテナーにのみ設定できます。
- 型
-
array
7.1.60. .spec.resources.claims[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。 |
|
|
| request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。 |
7.1.61. .spec.routes リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ルートは、レジストリー用に作成する必要がある追加の外部向けルートを定義します。
- 型
-
array
7.1.62. .spec.routes[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageRegistryConfigRoute は、イメージレジストリーへの外部ルートアクセスに関する情報を保持します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ルートのホスト名。 |
|
|
| 作成するルートの名前。 |
|
|
| secretName は、ルートで使用される証明書を含むシークレットを指します。 |
7.1.63. .spec.storage リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- レジストリーストレージを設定するためのストレージの詳細 (S3 バケット座標など)。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| azure は、Azure Blob Storage を使用する設定を表します。 |
|
|
| emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。 |
|
|
| gcs は、Google Cloud Storage を使用する設定を表します。 |
|
|
| ibmcos は、IBM Cloud Object Storage を使用する設定を表します。 |
|
|
| managementState は、Operator が基礎となるストレージ装置を管理しているかどうかを示します。マネージドの場合、この Operator が削除されると、Operator はストレージを削除します。 |
|
|
| Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。 |
|
|
| pvc は、PersistentVolumeClaim を使用する設定を表します。 |
|
|
| s3 は、Amazon Simple Storage Service を使用する設定を表します。 |
|
|
| swift は、OpenStack Object Storage を使用する設定を表します。 |
7.1.64. .spec.storage.azure リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- azure は、Azure Blob Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| accountName は、レジストリーで使用されるアカウントを定義します。 |
|
|
| cloudName は、レジストリーで使用される Azure クラウド環境の名前です。空の場合、Operator はインフラストラクチャーオブジェクトに基づいて設定します。 |
|
|
| コンテナーは、レジストリーで使用される Azure のコンテナーを定義します。 |
|
|
| networkAccess は、ストレージアカウントのネットワークアクセスプロパティーを定義します。デフォルトのタイプは External です。 |
7.1.65. .spec.storage.azure.networkAccess リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- networkAccess は、ストレージアカウントのネットワークアクセスプロパティーを定義します。デフォルトのタイプは External です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| internal は、プライベートエンドポイントを設定し、それをストレージアカウントに接続してプライベートにするための vnet 名とサブネット名を定義します。type: Internal および internal が設定されていない場合、Image Registry Operator が vnet 名とサブネット名を検出し、プライベートエンドポイント名を生成します。 |
|
|
| type は、ストレージアカウントに使用するネットワークアクセスレベルです。type: Internal の場合、ストレージアカウントがプライベートになります。type: External の場合、ストレージアカウントがパブリックにアクセス可能になります。Internal ストレージアカウントは、クラスターの vnet 内でのみ公開されます。External ストレージアカウントは、インターネット上で公開されます。type: Internal を使用する場合、vnetName、subNetName、privateEndpointName を必要に応じて指定できます。指定されていない場合、Image Registry Operator が vnet とサブネット名を検出し、privateEndpointName を生成します。デフォルトは "External" です。 |
7.1.66. .spec.storage.azure.networkAccess.internal リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- internal は、プライベートエンドポイントを設定し、それをストレージアカウントに接続してプライベートにするための vnet 名とサブネット名を定義します。type: Internal および internal が設定されていない場合、Image Registry Operator が vnet 名とサブネット名を検出し、プライベートエンドポイント名を生成します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| networkResourceGroupName は、クラスターの vnet とサブネットが存在するリソースグループ名です。省略すると、レジストリー Operator が (インフラストラクチャーステータス内の) クラスターリソースグループを使用します。install-config.yaml に networkResourceGroupName を設定すると、その値が自動的に使用されます (publish:Internal で設定されたクラスターの場合)。vnet とサブネットの両方が同じリソースグループ内にある必要があることに注意してください。1 - 90 文字の長さで、英数字、ハイフン (-)、ピリオド (.)、アンダースコア (_) のみで構成する必要があります。末尾をピリオドにすることはできません。 |
|
|
| privateEndpointName は、レジストリーのプライベートエンドポイントの名前です。指定すると、レジストリーでこの名前がストレージアカウント用に作成するプライベートエンドポイントの名前として使用されます。省略すると、レジストリーによって名前が生成されます。2 - 64 文字の長さで、英数字、ハイフン (-)、ピリオド (.)、アンダースコア (_) のみで構成する必要があります。先頭を英数字に、末尾を英数字またはアンダースコアにする必要があります。 |
|
|
|
subnetName は、レジストリーが動作するサブネットの名前です。省略した場合、レジストリー Operator が、vnet リソース内の |
|
|
|
vnetName は、レジストリーが動作する vnet の名前です。省略した場合、レジストリー Operator が、vnet リソース内の |
7.1.67. .spec.storage.emptyDir リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。
- 型
-
object
7.1.68. .spec.storage.gcs リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- gcs は、Google Cloud Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。 |
|
|
| keyID は、暗号化に使用する KMS キー ID です。オプションで、バケットは GCP でデフォルトで暗号化されます。これにより、カスタム暗号化キーを使用できます。 |
|
|
| projectID は、このバケットが関連付けられる必要がある GCP プロジェクトのプロジェクト ID です。 |
|
|
| リージョンは、バケットが存在する GCS の場所です。オプションで、インストールされている GCS リージョンに基づいて設定されます。 |
7.1.69. .spec.storage.ibmcos リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ibmcos は、IBM Cloud Object Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。 |
|
|
| location は、バケットが存在する IBM Cloud の場所です。オプションで、インストールされている IBM Cloud の場所に基づいて設定されます。 |
|
|
| resourceGroupName は、このバケットとそのサービスインスタンスが関連付けられている IBM Cloud リソースグループの名前です。オプションで、インストールされている IBM Cloud リソースグループに基づいて設定されます。 |
|
|
| resourceKeyCRN は、サービスインスタンス用に作成された IBM Cloud リソースキーの CRN です。一般にサービスクレデンシャルと呼ばれ、HMAC タイプのクレデンシャルが含まれている必要があります。オプションで、提供されていない場合は計算されます。 |
|
|
| serviceInstanceCRN は、このバケットが関連付けられている IBM Cloud Object Storage サービスインスタンスの CRN です。オプションで、提供されていない場合は計算されます。 |
7.1.70. .spec.storage.oss リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Bucket は、レジストリーのデータを保存するバケット名です。バケットの命名の詳細は、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/257087.htm) で確認できます。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは <clusterid>-image-registry-<リージョン>-<ランダムな 27 文字の文字列> という形式で自動生成されます。 |
|
|
| Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。 |
|
|
|
EndpointAccessibility は、レジストリーが OSS VPC 内部エンドポイントを使用するかどうかを指定します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは |
|
|
| Region は、バケットが存在する Alibaba Cloud リージョンです。リージョンのリストは、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/31837.html) を参照してください。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトはインストールされている Alibaba Cloud リージョンに基づいています。 |
7.1.71. .spec.storage.oss.encryption リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。 |
|
|
|
Method は、利用可能なさまざまな暗号化モードを定義します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは |
7.1.72. .spec.storage.oss.encryption.kms リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。
- 型
-
object - 必須
-
keyID
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KeyID は、KMS の暗号鍵 ID を保持します。 |
7.1.73. .spec.storage.pvc リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- pvc は、PersistentVolumeClaim を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| クレームは、使用される永続ボリュームクレームの名前を定義します。 |
7.1.74. .spec.storage.s3 リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- s3 は、Amazon Simple Storage Service を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。 |
|
|
| chunkSizeMiB は、S3 API のマルチパートアップロードチャンクのサイズを定義します。S3 API のマルチパートアップロードチャンクは、少なくとも 5MiB である必要があります。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルト値は 10 MiB です。値は整数の MiB です。最小値は 5、最大値は 5120 (5 GiB) です。 |
|
|
| cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。 |
|
|
| encrypt は、イメージが暗号化された形式で保存されるかどうかを指定します。オプションで、デフォルトは false です。 |
|
|
| keyID は、暗号化に使用する KMS キー ID です。オプションで、暗号化は true である必要があります。そうでない場合、このパラメーターは無視されます。 |
|
|
| リージョンはバケットが存在する AWS リージョンです。オプションで、インストールされている AWS リージョンに基づいて設定されます。 |
|
|
| regionEndpoint は、S3 互換のストレージサービスのエンドポイントです。スキームを含む有効な URL である必要があります (例: https://s3.example.com)。オプションで、提供される地域に基づくデフォルト。 |
|
|
| trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。 trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。 |
|
|
| virtualHostedStyle を使用すると、カスタムの RegionEndpoint オプションで S3 仮想ホストスタイルバケットパスを使用できます。デフォルトは false です。 |
7.1.75. .spec.storage.s3.cloudFront リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。
- 型
-
object - 必須
-
baseURL -
keypairID -
privateKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| baseURL には、Cloudfront が提供される SCHEME://HOST[/PATH] が含まれています。 |
|
|
| duration は、Cloudfront セッションの継続時間です。 |
|
|
| keypairID は、AWS が提供するキーペア ID です。 |
|
|
| privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。 |
7.1.76. .spec.storage.s3.cloudFront.privateKey リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。
- 型
-
object - 必須
-
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
|
| 参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
7.1.77. .spec.storage.s3.trustedCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。
trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される config map の metadata.name です。このフィールドは、標準の config map の命名制限に準拠する必要があります。名前は、英数字、ハイフン (-)、ピリオド (.) のみで構成する必要があります。最大長は 253 文字です。このフィールドが指定されていないか、空の文字列である場合、デフォルトのトラストバンドルが使用されます。 |
7.1.78. .spec.storage.swift リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- swift は、OpenStack Object Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| authURL は、認証トークンを取得するための URL を定義します。 |
|
|
| authVersion は、OpenStack Auth のバージョンを指定します。 |
|
|
| container は、レジストリーのデータを格納する Swift コンテナーの名前を定義します。 |
|
|
| domain は、Identityv3API の Openstack のドメイン名を指定します。 |
|
|
| domainID は、Identityv3API の Openstack のドメイン ID を指定します。 |
|
|
| regionName は、コンテナーが存在する Openstack のリージョンを定義します。 |
|
|
| テナントは、レジストリーが使用する Openstack テナント名を定義します。 |
|
|
| テナントは、レジストリーが使用する Openstack テナント ID を定義します。 |
7.1.79. .spec.tolerations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tolerations は、レジストリー Pod の許容値を定義します。
- 型
-
array
7.1.80. .spec.tolerations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。 |
|
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
7.1.81. .spec.topologySpreadConstraints リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- topologySpreadConstraints は、一致する Pod を特定のトポロジー内でどのように分散するかを指定します。
- 型
-
array
7.1.82. .spec.topologySpreadConstraints[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。
- 型
-
object - 必須
-
maxSkew -
topologyKey -
whenUnsatisfiable
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。 |
|
|
| MatchLabelKeys は、分散を計算する Pod を選択するための Pod ラベルキーのセットです。このようなキーは受信 Pod のラベルから値を検索するために使用され、このキーと値のラベルは labelSelector と AND 演算されて、受信 Pod の分散が計算される既存の Pod のグループを選択します。同じキーが MatchLabelKeys と LabelSelector の両方に存在することはできません。LabelSelector が設定されていないと、MatchLabelKeys は設定できません。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。 これはベータフィールドであり、MatchLabelKeysInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。 |
|
|
|
MaxSkew は、Pod が不均一に分布している可能性の程度を表します。 |
|
|
| 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 に違反するためです。 |
|
|
| nodeAffinityPolicy は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。 この値が nil の場合、この動作は Honor ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによってデフォルトで有効になるベータレベルの機能です。 |
|
|
| NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。 この値が nil の場合、この動作は Ignore ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによってデフォルトで有効になるベータレベルの機能です。 |
|
|
| TopologyKey は、ノードラベルのキーです。このキーと同じ値のラベルを持つノードは、同じトポロジーにあると見なされます。各 <key, value> を "バケット" と見なし、バランスの取れた数の Pod を各バケットに配置しようとします。ドメインをトポロジーの特定のインスタンスとして定義します。また、ノードが nodeAffinityPolicy および nodeTaintsPolicy の要件を満たすドメインとして、適格なドメインを定義します。たとえば、TopologyKey が "kubernetes.io/hostname" の場合、各ノードはそのトポロジーのドメインです。また、TopologyKey が "topology.kubernetes.io/zone" の場合は、各ゾーンがそのトポロジーのドメインになります。必須フィールドです。 |
|
|
| 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.83. .spec.topologySpreadConstraints[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
7.1.84. .spec.topologySpreadConstraints[].labelSelector.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
7.1.85. .spec.topologySpreadConstraints[].labelSelector.matchExpressions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
7.1.86. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageRegistryStatus は、イメージレジストリーの動作ステータスを報告します。
- 型
-
object - 必須
-
storage -
storageManaged
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| storage は、レジストリーの現在適用されているストレージ設定を示します。 |
|
|
| storageManaged は非推奨です。Storage.managementState を参照してください |
|
|
| バージョンは、この可用性が適用されるレベルです |
7.1.87. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
7.1.88. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
7.1.89. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
7.1.90. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| resource は追跡対象のリソースタイプです。 |
7.1.91. .status.storage リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- storage は、レジストリーの現在適用されているストレージ設定を示します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| azure は、Azure Blob Storage を使用する設定を表します。 |
|
|
| emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。 |
|
|
| gcs は、Google Cloud Storage を使用する設定を表します。 |
|
|
| ibmcos は、IBM Cloud Object Storage を使用する設定を表します。 |
|
|
| managementState は、Operator が基礎となるストレージ装置を管理しているかどうかを示します。マネージドの場合、この Operator が削除されると、Operator はストレージを削除します。 |
|
|
| Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。 |
|
|
| pvc は、PersistentVolumeClaim を使用する設定を表します。 |
|
|
| s3 は、Amazon Simple Storage Service を使用する設定を表します。 |
|
|
| swift は、OpenStack Object Storage を使用する設定を表します。 |
7.1.92. .status.storage.azure リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- azure は、Azure Blob Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| accountName は、レジストリーで使用されるアカウントを定義します。 |
|
|
| cloudName は、レジストリーで使用される Azure クラウド環境の名前です。空の場合、Operator はインフラストラクチャーオブジェクトに基づいて設定します。 |
|
|
| コンテナーは、レジストリーで使用される Azure のコンテナーを定義します。 |
|
|
| networkAccess は、ストレージアカウントのネットワークアクセスプロパティーを定義します。デフォルトのタイプは External です。 |
7.1.93. .status.storage.azure.networkAccess リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- networkAccess は、ストレージアカウントのネットワークアクセスプロパティーを定義します。デフォルトのタイプは External です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| internal は、プライベートエンドポイントを設定し、それをストレージアカウントに接続してプライベートにするための vnet 名とサブネット名を定義します。type: Internal および internal が設定されていない場合、Image Registry Operator が vnet 名とサブネット名を検出し、プライベートエンドポイント名を生成します。 |
|
|
| type は、ストレージアカウントに使用するネットワークアクセスレベルです。type: Internal の場合、ストレージアカウントがプライベートになります。type: External の場合、ストレージアカウントがパブリックにアクセス可能になります。Internal ストレージアカウントは、クラスターの vnet 内でのみ公開されます。External ストレージアカウントは、インターネット上で公開されます。type: Internal を使用する場合、vnetName、subNetName、privateEndpointName を必要に応じて指定できます。指定されていない場合、Image Registry Operator が vnet とサブネット名を検出し、privateEndpointName を生成します。デフォルトは "External" です。 |
7.1.94. .status.storage.azure.networkAccess.internal リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- internal は、プライベートエンドポイントを設定し、それをストレージアカウントに接続してプライベートにするための vnet 名とサブネット名を定義します。type: Internal および internal が設定されていない場合、Image Registry Operator が vnet 名とサブネット名を検出し、プライベートエンドポイント名を生成します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| networkResourceGroupName は、クラスターの vnet とサブネットが存在するリソースグループ名です。省略すると、レジストリー Operator が (インフラストラクチャーステータス内の) クラスターリソースグループを使用します。install-config.yaml に networkResourceGroupName を設定すると、その値が自動的に使用されます (publish:Internal で設定されたクラスターの場合)。vnet とサブネットの両方が同じリソースグループ内にある必要があることに注意してください。1 - 90 文字の長さで、英数字、ハイフン (-)、ピリオド (.)、アンダースコア (_) のみで構成する必要があります。末尾をピリオドにすることはできません。 |
|
|
| privateEndpointName は、レジストリーのプライベートエンドポイントの名前です。指定すると、レジストリーでこの名前がストレージアカウント用に作成するプライベートエンドポイントの名前として使用されます。省略すると、レジストリーによって名前が生成されます。2 - 64 文字の長さで、英数字、ハイフン (-)、ピリオド (.)、アンダースコア (_) のみで構成する必要があります。先頭を英数字に、末尾を英数字またはアンダースコアにする必要があります。 |
|
|
|
subnetName は、レジストリーが動作するサブネットの名前です。省略した場合、レジストリー Operator が、vnet リソース内の |
|
|
|
vnetName は、レジストリーが動作する vnet の名前です。省略した場合、レジストリー Operator が、vnet リソース内の |
7.1.95. .status.storage.emptyDir リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- emptyDir は、Pod のホストノード上のエフェメラルストレージを表します。警告: このストレージは複数のレプリカで使用することはできず、本番環境での使用には適していません。Pod が何らかの理由でノードから削除されると、emptyDir のデータは完全に削除されます。
- 型
-
object
7.1.96. .status.storage.gcs リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- gcs は、Google Cloud Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。 |
|
|
| keyID は、暗号化に使用する KMS キー ID です。オプションで、バケットは GCP でデフォルトで暗号化されます。これにより、カスタム暗号化キーを使用できます。 |
|
|
| projectID は、このバケットが関連付けられる必要がある GCP プロジェクトのプロジェクト ID です。 |
|
|
| リージョンは、バケットが存在する GCS の場所です。オプションで、インストールされている GCS リージョンに基づいて設定されます。 |
7.1.97. .status.storage.ibmcos リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ibmcos は、IBM Cloud Object Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。 |
|
|
| location は、バケットが存在する IBM Cloud の場所です。オプションで、インストールされている IBM Cloud の場所に基づいて設定されます。 |
|
|
| resourceGroupName は、このバケットとそのサービスインスタンスが関連付けられている IBM Cloud リソースグループの名前です。オプションで、インストールされている IBM Cloud リソースグループに基づいて設定されます。 |
|
|
| resourceKeyCRN は、サービスインスタンス用に作成された IBM Cloud リソースキーの CRN です。一般にサービスクレデンシャルと呼ばれ、HMAC タイプのクレデンシャルが含まれている必要があります。オプションで、提供されていない場合は計算されます。 |
|
|
| serviceInstanceCRN は、このバケットが関連付けられている IBM Cloud Object Storage サービスインスタンスの CRN です。オプションで、提供されていない場合は計算されます。 |
7.1.98. .status.storage.oss リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Oss は、Alibaba Cloud Object Storage Service を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Bucket は、レジストリーのデータを保存するバケット名です。バケットの命名の詳細は、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/257087.htm) で確認できます。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは <clusterid>-image-registry-<リージョン>-<ランダムな 27 文字の文字列> という形式で自動生成されます。 |
|
|
| Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。 |
|
|
|
EndpointAccessibility は、レジストリーが OSS VPC 内部エンドポイントを使用するかどうかを指定します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは |
|
|
| Region は、バケットが存在する Alibaba Cloud リージョンです。リージョンのリストは、[公式ドキュメント](https://www.alibabacloud.com/help/doc-detail/31837.html) を参照してください。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトはインストールされている Alibaba Cloud リージョンに基づいています。 |
7.1.99. .status.storage.oss.encryption リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Encryption は、サーバー側でデータを暗号化するかどうかを指定します。詳細は、[公式ドキュメント] (https://www.alibabacloud.com/help/doc-detail/117914.htm) を参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。 |
|
|
|
Method は、利用可能なさまざまな暗号化モードを定義します。値が空の場合、指定なしとみなされ、プラットフォームによってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトは |
7.1.100. .status.storage.oss.encryption.kms リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- KMS (キー管理サービス) は、KMS KeyID の構造体を保持する暗号化タイプです。
- 型
-
object - 必須
-
keyID
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KeyID は、KMS の暗号鍵 ID を保持します。 |
7.1.101. .status.storage.pvc リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- pvc は、PersistentVolumeClaim を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| クレームは、使用される永続ボリュームクレームの名前を定義します。 |
7.1.102. .status.storage.s3 リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- s3 は、Amazon Simple Storage Service を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| バケットは、レジストリーのデータを保存するバケット名です。オプションで、提供されていない場合は生成されます。 |
|
|
| chunkSizeMiB は、S3 API のマルチパートアップロードチャンクのサイズを定義します。S3 API のマルチパートアップロードチャンクは、少なくとも 5MiB である必要があります。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルト値は 10 MiB です。値は整数の MiB です。最小値は 5、最大値は 5120 (5 GiB) です。 |
|
|
| cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。 |
|
|
| encrypt は、イメージが暗号化された形式で保存されるかどうかを指定します。オプションで、デフォルトは false です。 |
|
|
| keyID は、暗号化に使用する KMS キー ID です。オプションで、暗号化は true である必要があります。そうでない場合、このパラメーターは無視されます。 |
|
|
| リージョンはバケットが存在する AWS リージョンです。オプションで、インストールされている AWS リージョンに基づいて設定されます。 |
|
|
| regionEndpoint は、S3 互換のストレージサービスのエンドポイントです。スキームを含む有効な URL である必要があります (例: https://s3.example.com)。オプションで、提供される地域に基づくデフォルト。 |
|
|
| trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。 trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。 |
|
|
| virtualHostedStyle を使用すると、カスタムの RegionEndpoint オプションで S3 仮想ホストスタイルバケットパスを使用できます。デフォルトは false です。 |
7.1.103. .status.storage.s3.cloudFront リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- cloudFront は Amazon Cloudfront をレジストリーでストレージミドルウェアとして設定します。
- 型
-
object - 必須
-
baseURL -
keypairID -
privateKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| baseURL には、Cloudfront が提供される SCHEME://HOST[/PATH] が含まれています。 |
|
|
| duration は、Cloudfront セッションの継続時間です。 |
|
|
| keypairID は、AWS が提供するキーペア ID です。 |
|
|
| privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。 |
7.1.104. .status.storage.s3.cloudFront.privateKey リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- privateKey は、AWS が提供する秘密鍵を含むシークレットを指します。
- 型
-
object - 必須
-
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
|
| 参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
7.1.105. .status.storage.s3.trustedCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
trustedCA は、CA バンドルを含む config map への参照です。イメージレジストリーとその Operator が、このバンドルの証明書を使用して S3 サーバー証明書を検証します。
trustedCA によって参照される config map の namespace は、"openshift-config" です。config map 内のバンドルのキーは、"ca-bundle.crt" です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される config map の metadata.name です。このフィールドは、標準の config map の命名制限に準拠する必要があります。名前は、英数字、ハイフン (-)、ピリオド (.) のみで構成する必要があります。最大長は 253 文字です。このフィールドが指定されていないか、空の文字列である場合、デフォルトのトラストバンドルが使用されます。 |
7.1.106. .status.storage.swift リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- swift は、OpenStack Object Storage を使用する設定を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| authURL は、認証トークンを取得するための URL を定義します。 |
|
|
| authVersion は、OpenStack Auth のバージョンを指定します。 |
|
|
| container は、レジストリーのデータを格納する Swift コンテナーの名前を定義します。 |
|
|
| domain は、Identityv3API の Openstack のドメイン名を指定します。 |
|
|
| domainID は、Identityv3API の Openstack のドメイン ID を指定します。 |
|
|
| regionName は、コンテナーが存在する Openstack のリージョンを定義します。 |
|
|
| テナントは、レジストリーが使用する Openstack テナント名を定義します。 |
|
|
| テナントは、レジストリーが使用する 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- Config のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Config のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- 設定を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
7.2.2. /apis/imageregistry.operator.openshift.io/v1/configs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 設定の名前 |
- HTTP メソッド
-
DELETE - 説明
- 設定を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Config を読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された設定を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された設定を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
7.2.3. /apis/imageregistry.operator.openshift.io/v1/configs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 設定の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された設定のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された設定のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された設定のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第8章 Config [samples.operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Config には、Samples Operator の設定と詳細な条件ステータスが含まれています。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
metadata -
spec
-
8.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 | |
|
|
| ConfigSpec には、Samples Operator に必要な設定と状態が含まれています。これにより、openshift namespace で作成/更新されるイメージストリームとテンプレートに関するさまざまな動作が制御されます。 |
|
|
| ConfigStatus には、実際の設定と、サンプル Operator の状態を説明するさまざまな詳細が含まれています。 |
8.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConfigSpec には、Samples Operator に必要な設定と状態が含まれています。これにより、openshift namespace で作成/更新されるイメージストリームとテンプレートに関するさまざまな動作が制御されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| アーキテクチャーは、インストールするハードウェアアーキテクチャーを決定します。現在サポートされている選択肢は、x86_64、ppc64le、および s390x のみです。 |
|
|
| managementState は、すべての Operator にとって最上位のオン/オフタイプのスイッチです。"Managed" の場合、この Operator は設定を処理し、それに応じてサンプルを操作します。"Unmanaged" 場合、この Operator は監視しているリソースの更新を無視します。"Removed" の場合、Operator は Config オブジェクトが削除された場合と同じように反応します。つまり、Operator が (スキップ対象のリストに従って) 管理する ImageStream またはテンプレートとレジストリーシークレットが、Operator の namespace 内にある、サンプルの操作に最後に使用された設定を表す ConfigMap とともに削除されます。 |
|
|
| samplesRegistry を使用すると、ImageStreams がイメージコンテンツのためにアクセスするレジストリーを指定できます。この github リポジトリーにプルされる https://github.com/openshift/library のコンテンツのデフォルトですが、ocp コンテンツのみのプルに基づいて、通常はデフォルトで registry.redhat.io になります。 |
|
|
| skippedImagestreams は、作成/更新してはならないイメージストリームの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
|
|
| skippedTemplates は、作成/更新してはならないテンプレートの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
8.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConfigStatus には、実際の設定と、サンプル Operator の状態を説明するさまざまな詳細が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| アーキテクチャーは、インストールするハードウェアアーキテクチャーを決定します。ここで、x86_64 と ppc64le がサポートされている選択肢です。 |
|
|
| 条件は、サンプルイメージストリームとテンプレートの利用可能なメンテナンスステータスを表します。 |
|
|
| ConfigCondition は、エントリーが処理されるときに Config のさまざまな条件をキャプチャします。 |
|
|
| managementState は、Operator のオン/オフスイッチの現在の動作ステータスを反映します。この Operator は、Operator をオンに戻していることを確認する一環として、ManagementState を比較します (つまり、以前は "アンマネージド" の場合は "マネージド")。 |
|
|
| samplesRegistry を使用すると、ImageStreams がイメージコンテンツのためにアクセスするレジストリーを指定できます。この github リポジトリーにプルされる https://github.com/openshift/library のコンテンツのデフォルトですが、ocp コンテンツのみのプルに基づいて、通常はデフォルトで registry.redhat.io になります。 |
|
|
| skippedImagestreams は、作成/更新してはならないイメージストリームの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
|
|
| skippedTemplates は、作成/更新してはならないテンプレートの名前を指定します。管理者はこれを使用して、不要なコンテンツを削除できるようにすることができます。コンテンツを手動で削除する必要がありますが、Operator はここにリストされているものを再作成 (または更新) しません。 |
|
|
| version は、最後に正常に処理されたときの Operator のペイロードベースのバージョンインジケーターの値です。 |
8.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、サンプルイメージストリームとテンプレートの利用可能なメンテナンスステータスを表します。
- 型
-
array
8.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConfigCondition は、エントリーが処理されるときに Config のさまざまな条件をキャプチャします。
- 型
-
object - 必須
-
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。 |
|
|
| lastUpdateTime は、この条件が最後に更新された時刻です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。 |
|
|
| 理由は、条件の最後の遷移を引き起こしたものです。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| 状態のタイプ。 |
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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- Config のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Config のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- 設定を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
8.2.2. /apis/samples.operator.openshift.io/v1/configs/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 設定の名前 |
- HTTP メソッド
-
DELETE - 説明
- 設定を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Config を読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された設定を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された設定を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
8.2.3. /apis/samples.operator.openshift.io/v1/configs/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 設定の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された設定のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された設定のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された設定のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第9章 CSISnapshotController [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
CSISnapshotController は、CSI スナップショットを管理するように Operator を設定する手段を提供します。
clusterは正規名です。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
9.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 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
9.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
9.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
9.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
9.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
9.1.5. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
9.1.6. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- CSISnapshotController のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が CSISnapshotController のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- CSISnapshotController を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空白 |
9.2.2. /apis/operator.openshift.io/v1/csisnapshotcontrollers/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| CSISnapshotController の名前 |
- HTTP メソッド
-
DELETE - 説明
- CSISnapshotController を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された CSISnapshotController を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された CSISnapshotController を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された CSISnapshotController を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
9.2.3. /apis/operator.openshift.io/v1/csisnapshotcontrollers/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| CSISnapshotController の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された CSISnapshotController のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された CSISnapshotController のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された CSISnapshotController のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 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. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 | |
|
|
| spec は、DNS の望ましい動作の仕様です。 |
|
|
| status は、DNS の最後に観察されたステータスです。 |
10.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、DNS の望ましい動作の仕様です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| cache は、Corefile にリストされているすべてのサーバーブロックに適用されるキャッシュ設定を表します。このフィールドでは、クラスター管理者が必要に応じて以下を設定できます。* positiveTTL: これは肯定応答をキャッシュする期間です。* negativeTTL: これは否定応答をキャッシュする期間です。これが設定されていない場合、OpenShift はデフォルト値を使用してポジティブキャッシュとネガティブキャッシュを設定します。デフォルト値は変更される可能性があります。執筆時点では、デフォルトの positiveTTL は 900 秒、デフォルトの negativeTTL は 30 秒です。または、お使いの OpenShift バージョンの Corefile に記載されているとおりです。 |
|
|
| logLevel は、CoreDNS に必要なログの詳細度を表します。次のいずれかの値を指定できます。* Normal: アップストリームリゾルバーからのエラーをログに記録します。* Debug: エラー、NXDOMAIN 応答、および NODATA 応答をログに記録します。* Trace: エラーとすべての応答をログに記録します。logLevel: Trace を設定すると、非常に詳細なログが生成されます。有効な値は、"Normal"、"Debug"、"Trace" です。Defaults to "Normal". |
|
|
| managementState は、DNS Operator がクラスター DNS を管理する必要があるかどうかを示します |
|
|
| nodePlacement は、DNS Pod のスケジューリングを明示的に制御します。一般に、すべてのノードで DNS Pod を実行すると、ネットワークを介して別のノードの DNS Pod に移動するのではなく、常にローカル DNS Pod によって DNS クエリーが処理されるようになります。ただし、セキュリティーポリシーでは、DNS Pod の配置を特定のノードに制限する必要がある場合があります。たとえば、セキュリティーポリシーで、任意のノード上の Pod が API と通信することを禁止している場合、ノードセレクターを指定して、DNS Pod を API との通信が許可されているノードに制限できます。逆に、特定のテイントのあるノードで DNS Pod を実行する必要がある場合は、そのテイントに対して許容範囲を指定できます。設定されていない場合、デフォルトが使用されます。詳細は、nodePlacement を参照してください。 |
|
|
| operatorLogLevel は、DNS Operator のログレベルを制御します。有効な値は、"Normal"、"Debug"、"Trace" です。デフォルトは "Normal" です。operatorLogLevel: Trace を設定すると、非常に詳細なログが生成されます。 |
|
|
| servers は、クラスタードメインのスコープ外にある 1 つ以上のサブドメインに名前クエリーの委譲を提供する DNS リゾルバーのリストです。servers に複数のサーバーが含まれている場合は、最長後方一致を使用してサーバーが決定されます。たとえば、2 つのサーバーがあり、1 つは "foo.com" 用、もう 1 つは "a.foo.com" 用で、名前クエリーが "www.a.foo.com" 用である場合、そのクエリーはゾーンが "a.foo.com" のサーバーにルーティングされます。このフィールドが nil の場合、サーバーは作成されません。 |
|
|
| Server は、CoreDNS のインスタンスごとに実行されるサーバーのスキーマを定義します。 |
|
|
| upstreamResolvers は、デフォルト (".") サーバーの場合に、CoreDNS が DNS メッセージをアップストリームリゾルバーにプロキシーするように設定するためのスキーマを定義します。このフィールドが指定されていない場合、使用されるアップストリームはデフォルトで/etc/resolv.conf になり、ポリシーは "sequential" になります。 |
10.1.2. .spec.cache リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- cache は、Corefile にリストされているすべてのサーバーブロックに適用されるキャッシュ設定を表します。このフィールドでは、クラスター管理者が必要に応じて以下を設定できます。* positiveTTL: これは肯定応答をキャッシュする期間です。* negativeTTL: これは否定応答をキャッシュする期間です。これが設定されていない場合、OpenShift はデフォルト値を使用してポジティブキャッシュとネガティブキャッシュを設定します。デフォルト値は変更される可能性があります。執筆時点では、デフォルトの positiveTTL は 900 秒、デフォルトの negativeTTL は 30 秒です。または、お使いの OpenShift バージョンの Corefile に記載されているとおりです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| negativeTTL は任意であり、否定応答をキャッシュする時間を指定します。設定する場合、1s (1 秒) 以上の値にする必要があります。理論上の最大値は数年です。このフィールドには、符号なしの 10 進数の期間文字列を指定する必要があります。それぞれの数字に少数 (任意) と単位の接尾辞を付けます。たとえば、"100s"、"1m30s"、"12h30m10s" です。秒の小数点以下の値は、最も近い秒に切り捨てられます。設定した値が 1 秒未満の場合、デフォルト値が使用されます。設定されていない場合、値は 0 秒になり、OpenShift の各バージョンの Corefile に特に記載がない限り、OpenShift はデフォルト値の 30 秒を使用します。デフォルト値の 30 秒は変更される可能性があります。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| nodeSelector は、DNS Pod に適用されるノードセレクターです。空の場合、デフォルトが使用されます。現在は次のとおりです。kubernetes.io/os:linux このデフォルトは変更される可能性があります。設定されている場合、指定されたセレクターが使用され、デフォルトが置き換えられます。 |
|
|
| 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/ を参照してください |
|
|
| この 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| forwardPlugin は、DNS メッセージをアップストリームリゾルバーにプロキシーするように CoreDNS を設定するためのスキーマを定義します。 |
|
|
| name は必須であり、サーバーの一意の名前を指定します。名前は、rfc6335 のサービス名構文に準拠している必要があります。 |
|
|
| zones は必須であり、サーバーが権限を持つサブドメインを指定します。ゾーンは、サブドメインの rfc1123 定義に準拠している必要があります。クラスタードメイン (つまり、"cluster.local") の指定は無効です。 |
10.1.8. .spec.servers[].forwardPlugin リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- forwardPlugin は、DNS メッセージをアップストリームリゾルバーにプロキシーするように CoreDNS を設定するためのスキーマを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| policy は、アップストリームサーバーをクエリーのために選択する順序を決定するために使用します。次のいずれかの値を指定できます。* "Random": クエリーごとにランダムなアップストリームサーバーを選択します。* "RoundRobin": ラウンドロビンの順序でアップストリームサーバーを選択し、新しいクエリーごとに次のサーバーに移動します。* "Sequential": 新しいクエリーごとに最初のサーバーから始めて、応答が得られるまでアップストリームサーバーに順番にクエリーを試行します。デフォルト値は "Random" です。 |
|
|
| protocolStrategy は、アップストリーム DNS リクエストに使用するプロトコルを指定します。protocolStrategy の有効な値は "TCP" です (省略可能)。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトでは、元のクライアントリクエストのプロトコルが使用されます。"TCP" に設定すると、クライアントリクエストが UDP を使用する場合でも、すべてのアップストリーム DNS リクエストに対して TCP が必ず使用されます。"TCP" は、非準拠のアップストリームリゾルバーなどによって発生する UDP 固有の問題には役立ちます。ただし、消費される帯域幅が増加したり、DNS 応答時間が長くなったりする可能性があります。protocolStrategy は、CoreDNS がアップストリームリゾルバーに対して行う DNS リクエストのプロトコルにのみ影響することに注意してください。クライアントと CoreDNS 間の DNS リクエストのプロトコルには影響しません。 |
|
|
| transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。 |
|
|
| upstreams は、ゾーンのサブドメインの名前クエリーを転送するリゾルバーのリストです。CoreDNS の各インスタンスは、アップストリームのヘルスチェックを実行します。正常なアップストリームが交換中にエラーを返すと、アップストリームの別のリゾルバーが試行されます。アップストリームは、ポリシーで指定された順序で選択されます。各アップストリームは、アップストリームが 53 以外のポートでリッスンしている場合、IP アドレスまたは IP: ポートで表されます。ForwardPlugin ごとに最大 15 個のアップストリームが許可されます。 |
10.1.9. .spec.servers[].forwardPlugin.transportConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| tls には、トランスポートが "TLS" に設定されているときに使用する追加の設定オプションを含めます。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
caBundle は、1 つの CA 証明書か CA バンドルを含んでいる必要がある ConfigMap を参照します。これを使用すると、クラスター管理者は、アップストリームリゾルバーの証明書を検証するための独自の CA または CA バンドルを指定できます。1. configmap には |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される config map の metadata.name です |
10.1.12. .spec.upstreamResolvers リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- upstreamResolvers は、デフォルト (".") サーバーの場合に、CoreDNS が DNS メッセージをアップストリームリゾルバーにプロキシーするように設定するためのスキーマを定義します。このフィールドが指定されていない場合、使用されるアップストリームはデフォルトで/etc/resolv.conf になり、ポリシーは "sequential" になります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Policy は、アップストリームサーバーをクエリーのために選択する順序を決定するために使用します。次のいずれかの値を指定できます。* "Random": クエリーごとにランダムなアップストリームサーバーを選択します。* "RoundRobin": ラウンドロビンの順序でアップストリームサーバーを選択し、新しいクエリーごとに次のサーバーに移動します。* "Sequential": 新しいクエリーごとに最初のサーバーから始めて、応答が得られるまでアップストリームサーバーに順番にクエリーを試行します。デフォルト値は "Sequential" です。 |
|
|
| protocolStrategy は、アップストリーム DNS リクエストに使用するプロトコルを指定します。protocolStrategy の有効な値は "TCP" です (省略可能)。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトでは、元のクライアントリクエストのプロトコルが使用されます。"TCP" に設定すると、クライアントリクエストが UDP を使用する場合でも、すべてのアップストリーム DNS リクエストに対して TCP が必ず使用されます。"TCP" は、非準拠のアップストリームリゾルバーなどによって発生する UDP 固有の問題には役立ちます。ただし、消費される帯域幅が増加したり、DNS 応答時間が長くなったりする可能性があります。protocolStrategy は、CoreDNS がアップストリームリゾルバーに対して行う DNS リクエストのプロトコルにのみ影響することに注意してください。クライアントと CoreDNS 間の DNS リクエストのプロトコルには影響しません。 |
|
|
| transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。 |
|
|
| Upstreams は、"."ドメインの名前クエリーを転送するリゾルバーのリストです。CoreDNS の各インスタンスは、アップストリームのヘルスチェックを実行します。正常なアップストリームが交換中にエラーを返すと、アップストリームの別のリゾルバーが試行されます。アップストリームは、ポリシーで指定された順序で選択されます。ForwardPlugin ごとに最大 15 個のアップストリームが許可されます。アップストリームが指定されていない場合は、デフォルトで /etc/resolv.conf が使用されます。 |
|
|
| アップストリームは、SystemResolvConf タイプか Network タイプのどちらかです。- アップストリームが SystemResolvConf タイプの場合、追加のフィールドは必要ありません。アップストリームは /etc/resolv.conf を使用するように設定されます。- アップストリームが Network タイプの場合、アップストリームが 53 以外のポートでリッスンするのであれば、NetworkResolver フィールドを IP アドレスまたは IP:port で定義する必要があります。 |
10.1.13. .spec.upstreamResolvers.transportConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- transportConfig は、DNS リクエストをアップストリームリゾルバーに転送するときに使用するトランスポートタイプ、サーバー名、およびオプションのカスタム CA または CA バンドルを設定するために使用します。デフォルト値は "" (空) です。デフォルト値の場合、DNS リクエストをアップストリームリゾルバーに転送するときに標準のクリアテキスト接続が使用されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| tls には、トランスポートが "TLS" に設定されているときに使用する追加の設定オプションを含めます。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
caBundle は、1 つの CA 証明書か CA バンドルを含んでいる必要がある ConfigMap を参照します。これを使用すると、クラスター管理者は、アップストリームリゾルバーの証明書を検証するための独自の CA または CA バンドルを指定できます。1. configmap には |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- アップストリームは、SystemResolvConf タイプか Network タイプのどちらかです。- アップストリームが SystemResolvConf タイプの場合、追加のフィールドは必要ありません。アップストリームは /etc/resolv.conf を使用するように設定されます。- アップストリームが Network タイプの場合、アップストリームが 53 以外のポートでリッスンするのであれば、NetworkResolver フィールドを IP アドレスまたは IP:port で定義する必要があります。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Address は、Type が Network に設定されている場合に定義する必要があります。それ以外の場合は無視されます。有効な IPv4 または IPv6 アドレスである必要があります。 |
|
|
| Port は、Type が Network に設定されている場合に定義する必要があります。それ以外の場合は無視されます。ポートは 65535 までである必要があります。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 は、この 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 |
|
|
| 条件は、クラスター上の DNS の状態に関する情報を提供します。サポートされている DNS 条件は次のとおりです。*使用可能 - 次の条件が満たされた場合に真になります。*DNS コントローラーデーモンセットが使用可能です。- これらの条件のいずれかが満たされていない場合は False。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
10.1.19. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、クラスター上の DNS の状態に関する情報を提供します。サポートされている DNS 条件は次のとおりです。*使用可能 - 次の条件が満たされた場合に真になります。*DNS コントローラーデーモンセットが使用可能です。- これらの条件のいずれかが満たされていない場合は False。
- 型
-
array
10.1.20. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- DNS のコレクションを削除する
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が DNS のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- DNS を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
10.2.2. /apis/operator.openshift.io/v1/dnses/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| DNS の名前 |
- HTTP メソッド
-
DELETE - 説明
- DNS を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された DNS を読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された DNS を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された DNS を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
10.2.3. /apis/operator.openshift.io/v1/dnses/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| DNS の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された DNS のステータスを読み取る
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された DNS のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された DNS のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第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. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 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 | |
|
|
| spec は、dnsRecord の望ましい動作の仕様です。 |
|
|
| status は、dnsRecord の最後に観察されたステータスです。 |
11.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、dnsRecord の望ましい動作の仕様です。
- 型
-
object - 必須
-
dnsManagementPolicy -
dnsName -
recordTTL -
recordType -
targets
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| dnsManagementPolicy は、DNS レコードに適用されている現在のポリシーを示します。ポリシーが "Unmanaged" に設定されているレコードは、Ingress Operator によって無視されます。この場合、クラウドプロバイダー上の DNS レコードは、Operator によって管理されません。外部で管理されるため、"Published" ステータス状態が "Unknown" ステータスに更新されます。クラウドプロバイダー上の既存のレコードは、クラスター管理者の判断で削除できます。 このフィールドのデフォルトは Managed です。有効な値は "Managed" と "Unmanaged" です。 |
|
|
| dnsName は、DNS レコードのホスト名です |
|
|
| recordTTL は、秒単位のレコード TTL です。ゼロの場合、デフォルトは 30 です。RecordTTL は、AWS リージョンのエイリアスターゲットでは使用されませんが、AWS API コントラクトに従って、CNAME ターゲットで使用されます。 |
|
|
| recordType は DNS レコードタイプです。たとえば、"A" または "CNAME"。 |
|
|
| ターゲットはレコードターゲットです。 |
11.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、dnsRecord の最後に観察されたステータスです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| observedGeneration は、最近観察された DNSRecord の世代です。DNSRecord が更新されると、コントローラーは各マネージドゾーンの対応するレコードを更新します。特定のゾーンの更新が失敗した場合、その失敗はゾーンのステータス条件に記録されるため、コントローラーはその特定のゾーンの更新を再試行する必要があると判断できます。 |
|
|
| ゾーンは、各ゾーンのレコードのステータスです。 |
|
|
| DNSZoneStatus は、特定のゾーン内のレコードのステータスです。 |
11.1.3. .status.zones リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ゾーンは、各ゾーンのレコードのステータスです。
- 型
-
array
11.1.4. .status.zones[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- DNSZoneStatus は、特定のゾーン内のレコードのステータスです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、ゾーン内のレコードに関連する状態です。 レコードの公開が成功すると、"Published" 状態のステータスが "True" に設定されます。失敗すると、"False" に設定され、失敗の原因を説明する理由とメッセージが提供されます。 |
|
|
| DNSZoneCondition は、単なる標準の条件フィールドです。 |
|
|
| dnsZone は、レコードが公開されるゾーンです。 |
11.1.5. .status.zones[].conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
conditions は、ゾーン内のレコードに関連する状態です。
レコードの公開が成功すると、"Published" 状態のステータスが "True" に設定されます。失敗すると、"False" に設定され、失敗の原因を説明する理由とメッセージが提供されます。
- 型
-
array
11.1.6. .status.zones[].conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- DNSZoneCondition は、単なる標準の条件フィールドです。
- 型
-
object - 必須
-
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
11.1.7. .status.zones[].dnsZone リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- dnsZone は、レコードが公開されるゾーンです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| id は、DNS ホストゾーンを見つけるために使用できる識別子です。
AWS ゾーンでは [1] の 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 |
|
|
| タグは DNS ホストゾーンをクエリーするために使用できます。
AWS では、resourcegroupstaggingapi [1] を使用し、 [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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
GET - 説明
- 種類が DNSRecord のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
11.2.2. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- DNSRecord のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が DNSRecord のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- DNSRecord を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
11.2.3. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| DNSRecord の名前 |
- HTTP メソッド
-
DELETE - 説明
- DNSRecord を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された DNSRecord を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された DNSRecord を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された DNSRecord を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
11.2.4. /apis/ingress.operator.openshift.io/v1/namespaces/{namespace}/dnsrecords/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| DNSRecord の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された DNSRecord のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された DNSRecord のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された DNSRecord のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第12章 Etcd [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Etcd は、etcd を管理するように Operator を設定するための情報を提供します。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
spec
-
12.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 | |
|
|
| |
|
|
|
12.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| HardwareSpeed を使用すると、ハートビート間隔とリーダー選出タイムアウトのレイテンシーパラメーターを設定する etcd チューニングプロファイルを変更して、クラスターで許容される etcd メンバー間のラウンドトリップ時間を延長できます。有効な値は、""、"Standard"、"Slower" です。"" の場合、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、予告なく変更される可能性があります。 |
|
|
| failedRevisionLimit は、ディスク上に保持するために失敗した静的 Pod インストーラーリビジョンの数であり、API では -1 =無制限、0 または未設定= 5(デフォルト) |
|
|
| forceRedeploymentReason を使用すると、一意の文字列を指定して、オペランドの再デプロイを強制できます。これにより、以前に失敗したデプロイメントを開始するメカニズムが提供され、同じ設定で再度失敗するのではなく、今回は機能すると思われる理由が提供されます。 |
|
|
| logLevel は、コンポーネント全体のインテントベースのログです。きめ細かい制御はできませんが、Operator がオペランドに対して解釈する必要のある粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| managementState は、Operator がコンポーネントを管理する必要があるかどうか、およびその方法を示します |
|
| `` | observedConfig は、コントローラーがクラスター状態から監視したスパース設定を保持します。Operator のレベルへの入力であるため、仕様に存在します |
|
|
| operatorLogLevel は、Operator 自体のインテントベースのログです。きめ細かい制御はできませんが、Operator が自分で解釈しなければならない粗いロギングの選択を管理する簡単な方法です。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| succeededRevisionLimit は、ディスク上に保持する成功した静的 Pod インストーラーリビジョンの数であり、API では -1 =無制限、0 または未設定= 5(デフォルト) |
|
| `` | unsupportedConfigOverrides は、Operator によって計算された最終設定をオーバーライドします。Red Hat はこのフィールドの使用をサポートしていません。このフィールドを誤って使用すると、予期しない動作が発生したり、他の設定オプションと競合したりする可能性があります。このフィールドを使用する前に、Red Hat サポートに問い合わせてください。このプロパティーを使用すると、クラスターのアップグレードがブロックされます。クラスターをアップグレードする前に、このプロパティーを削除する必要があります。 |
12.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| ControlPlaneHardwareSpeed は、有効なハードウェア速度許容レベルを宣言します。 |
|
|
| generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。 |
|
|
| GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。 |
|
|
| latestAvailableRevision は、最新のデプロイメントの deploymentID です。 |
|
|
| latestAvailableRevisionReason は、最新のデプロイメントの詳細な理由を説明します |
|
|
| nodeStatuses は、個々のノード全体のデプロイメント値とエラーを追跡します |
|
|
| NodeStatus は、この Operator によって管理される特定のノードの現在の状態に関する情報を提供します。 |
|
|
| observedGeneration はあなたが扱った最後の世代の変更です |
|
|
| readyReplicas は、準備ができて目的の状態にあるレプリカの数を示します |
|
|
| バージョンは、この可用性が適用されるレベルです |
12.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
12.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
12.1.5. .status.generations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- generations は、項目を調整する必要があるタイミングや、対応が必要な変更が項目に対して行われたタイミングを判断するために使用します。
- 型
-
array
12.1.6. .status.generations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GenerationStatus は、強制更新に関する決定を行えるように、特定のリソースの生成を追跡します。
- 型
-
object - 必須
-
group -
name -
namespace -
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は追跡対象のグループです。 |
|
|
| hash は、シークレットや configmap など、機密性の高いコンテンツを含む生成されないリソースに設定される任意のフィールドです。 |
|
|
| lastGeneration は関連するワークロードコントローラーの最後の生成です。 |
|
|
| name は追跡対象の名前です。 |
|
|
| namespace は追跡対象の場所です。 |
|
|
| resource は追跡対象のリソースタイプです。 |
12.1.7. .status.nodeStatuses リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- nodeStatuses は、個々のノード全体のデプロイメント値とエラーを追跡します
- 型
-
array
12.1.8. .status.nodeStatuses[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- NodeStatus は、この Operator によって管理される特定のノードの現在の状態に関する情報を提供します。
- 型
-
object - 必須
-
nodeName
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| currentRevision は、直近で成功したデプロイメントの世代です。nodeStatus の作成時には設定できません。更新では、値を増加させることしかできません。 |
|
|
| lastFailedCount は、最後に失敗したリビジョンのインストーラー Pod が失敗した頻度です。 |
|
|
| lastFailedReason は、機械で読み取り可能な障害理由文字列です。 |
|
|
| lastFailedRevision は、デプロイを試みて失敗したデプロイメントの世代です。 |
|
|
| lastFailedRevisionErrors は、lastFailedRevision で参照されているデプロイメントの失敗時に人間が読み取れるエラーのリストです。 |
|
|
| lastFailedTime は、最後に失敗したリビジョンが最後に失敗した時刻です。 |
|
|
| lastFallbackCount は、前のリビジョンへのフォールバックが発生した頻度です。 |
|
|
| nodeName はノードの名前です |
|
|
| targetRevision は、適用しようとしているデプロイメントの世代です。nodeStatus の作成時には設定できません。 |
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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- Etcd のコレクションを削除する
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Etcd のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- Etcd を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
12.2.2. /apis/operator.openshift.io/v1/etcds/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Etcd の名前 |
- HTTP メソッド
-
DELETE - 説明
- Etcd を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Etcd を読む
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Etcd を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Etcd を交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
12.2.3. /apis/operator.openshift.io/v1/etcds/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Etcd の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された Etcd のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Etcd のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Etcd のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第13章 ImageContentSourcePolicy [operator.openshift.io/v1alpha1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ImageContentSourcePolicy は、レジストリーミラールールの処理方法に関するクラスター全体の情報を保持します。複数のポリシーが定義されている場合、動作の結果は各フィールドで定義されます。
互換性レベル 4: 互換性は提供されていません。API は、理由を問わずいつでも変更できます。これらの機能は、長期サポートを必要とするアプリケーションで使用することはできません。
- 型
-
object - 必須
-
spec
-
13.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 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
13.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| repositoryDigestMirrors を使用すると、Pod 内のイメージダイジェストによって参照されるイメージを、ミラーリングされた代替のリポジトリーの場所から取得できます。Pod に提供されるイメージプル仕様は、RepositoryDigestMirrors で説明されているソースの場所と比較され、管理者が潜在的に高速なミラーを選択できるように、指定されたリポジトリーではなく、リスト内の任意のミラーからイメージをプルダウンできます。イメージダイジェストを持つイメージプル仕様にのみ、この動作が適用されます。タグは、プル仕様で指定されたリポジトリーから引き続きプルされます。 各 “ソース” リポジトリーは独立して扱われます。異なる “ソース” リポジトリーの設定は相互作用しません。
同じ “ソース” リポジトリーに対して複数のポリシーが定義されている場合、定義されたミラーのセットは一緒にマージされ、可能であればミラーの相対的な順序が維持されます。たとえば、ポリシー A にミラー |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 同じイメージが含まれる可能性のあるリポジトリーを 1 つ以上指定します。このリスト内のミラーの順序はユーザーの希望する優先度として扱われますが、ソースはデフォルトですべてのミラーよりも低い優先度と見なされます。他の repositoryDigestMirrors オブジェクトを含む (ただしこれらに限定されない) 他のクラスター設定は、ミラーが接続される正確な順序に影響を与える可能性があります。 |
|
|
| 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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- ImageContentSourcePolicy のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ImageContentSourcePolicy のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ImageContentSourcePolicy を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空白 |
13.2.2. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ImageContentSourcePolicy の名前 |
- HTTP メソッド
-
DELETE - 説明
- ImageContentSourcePolicy を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ImageContentSourcePolicy を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ImageContentSourcePolicy を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ImageContentSourcePolicy を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
13.2.3. /apis/operator.openshift.io/v1alpha1/imagecontentsourcepolicies/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ImageContentSourcePolicy の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ImageContentSourcePolicy のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ImageContentSourcePolicy のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ImageContentSourcePolicy のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
第14章 ImagePruner [imageregistry.operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ImagePruner は、レジストリー Operator によって管理されるイメージレジストリープルーナーの設定オブジェクトです。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object - 必須
-
metadata -
spec
-
14.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 | |
|
|
| ImagePrunerSpec は、実行中のイメージ剪定ばさみの仕様を定義します。 |
|
|
| ImagePrunerStatus は、イメージプルーナーの動作ステータスを報告します。 |
14.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImagePrunerSpec は、実行中のイメージ剪定ばさみの仕様を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| アフィニティーは、イメージ剪定ばさみ Pod のノードアフィニティースケジューリングルールのグループです。 |
|
|
| failedJobsHistoryLimit は、保持する失敗したイメージプルーナージョブの数を指定します。設定されていない場合は、デフォルトで 3 に設定されます。 |
|
|
| ignoreInvalidImageReferences は、イメージ参照の解析中にプルーナーがエラーを無視できるかどうかを示します。 |
|
|
| keepTagRevisions は、保持されるイメージストリーム内のタグのイメージリビジョンの数を指定します。デフォルトは 3 です。 |
|
|
| keepYoungerThan は、プルーニングの候補と見なされるイメージとそのリファラーの最小年齢をナノ秒単位で指定します。非推奨: このフィールドは非推奨になり、keepYoungerThanDuration が優先されます。両方が設定されている場合、このフィールドは無視され、keepYoungerThanDuration が優先されます。 |
|
|
| keepYoungerThanDuration は、プルーニングの候補と見なされるイメージとそのリファラーの最小年齢を指定します。デフォルトは 60m (60 分) です。 |
|
|
| logLevel は、プルーナージョブのログ出力のレベルを設定します。 有効な値は、"Normal"、"Debug"、"Trace"、"TraceAll" です。Defaults to "Normal". |
|
|
| nodeSelector は、イメージ剪定ばさみ Pod のノード選択制約を定義します。 |
|
|
| resources は、イメージ剪定ばさみ Pod のリソースリクエストと制限を定義します。 |
|
|
|
スケジュールは、標準の cronjob 構文を使用してジョブを実行するタイミングを指定します (https://wikipedia.org/wiki/Cron)。デフォルトは |
|
|
| successfulJobsHistoryLimit は、保持する成功したイメージプルーナージョブの数を指定します。設定されていない場合は、デフォルトで 3 に設定されます。 |
|
|
| suspend は、この cronjob の後続の実行を一時停止するかどうかを指定します。デフォルトは false です。 |
|
|
| tolerations は、イメージ剪定ばさみ Pod のノード許容値を定義します。 |
|
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
14.1.2. .spec.affinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- アフィニティーは、イメージ剪定ばさみ Pod のノードアフィニティースケジューリングルールのグループです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Pod のノードアフィニティースケジューリングルールを説明します。 |
|
|
| Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。 |
|
|
| Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。 |
14.1.3. .spec.affinity.nodeAffinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod のノードアフィニティースケジューリングルールを説明します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
|
| 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。 |
|
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 対応する重みに関連付けられたノードセレクター用語。 |
|
|
| 対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。 |
14.1.6. .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 対応する重みに関連付けられたノードセレクター用語。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
14.1.11. .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。
- 型
-
object - 必須
-
nodeSelectorTerms
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。ノードセレクター用語のリスト。用語は OR されています。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードのラベルごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| ノードのフィールドごとのノードセレクター要件のリスト。 |
|
|
| ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
- 説明
- ノードのラベルごとのノードセレクター要件のリスト。
- 型
-
array
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
- 説明
- ノードのフィールドごとのノードセレクター要件のリスト。
- 型
-
array
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| セレクターが適用されるラベルキー。 |
|
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。 |
|
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
14.1.18. .spec.affinity.podAffinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
|
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
|
| この 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
14.1.21. .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object - 必須
-
topologyKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
14.1.30. .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
14.1.36. .spec.affinity.podAntiAffinity リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod のアンチアフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スケジューラーは、このフィールドで指定されたアンチアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 |
|
|
| 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。 |
|
|
| このフィールドで指定されたアンチアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアンチアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから退避しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
|
|
| この 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 |
|
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
14.1.39. .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 必須。対応する重みに関連付けられた Pod アフィニティー用語。
- 型
-
object - 必須
-
topologyKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
- 説明
- 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。 |
|
|
|
MatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
|
MismatchLabelKeys は、考慮する Pod を選択するための Pod ラベルキーのセットです。キーは、着信 Pod ラベルから値を検索するために使用され、それらのキー値ラベルは |
|
|
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 |
|
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび null namespaceSelector は、"この Pod の namespace" を意味します |
|
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
14.1.48. .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- リソースのセット (この場合は Pod) に対するラベルクエリー。null の場合、この PodAffinityTerm はどの Pod とも一致しません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
14.1.54. .spec.resources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- resources は、イメージ剪定ばさみ Pod のリソースリクエストと制限を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。 これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。 このフィールドは変更不可能です。これはコンテナーにのみ設定できます。 |
|
|
| ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。 |
|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
14.1.55. .spec.resources.claims リンクのコピーリンクがクリップボードにコピーされました!
- 説明
Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。
これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。
このフィールドは変更不可能です。これはコンテナーにのみ設定できます。
- 型
-
array
14.1.56. .spec.resources.claims[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。 |
|
|
| request は、参照されるクレーム内のリクエストに対して選択された名前です。空の場合、クレームからのすべてのものが利用可能になり、それ以外の場合はこの request の結果のみが利用可能になります。 |
14.1.57. .spec.tolerations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tolerations は、イメージ剪定ばさみ Pod のノード許容値を定義します。
- 型
-
array
14.1.58. .spec.tolerations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。 |
|
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
14.1.59. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImagePrunerStatus は、イメージプルーナーの動作ステータスを報告します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、状態とそのステータスのリストです。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| observedGeneration は、適用された最後の世代の変更です。 |
14.1.60. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、状態とそのステータスのリストです。
- 型
-
array
14.1.61. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
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 リンクのコピーリンクがクリップボードにコピーされました!
- HTTP メソッド
-
DELETE - 説明
- ImagePruner のコレクションを削除します
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ImagePruner のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ImagePruner を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
14.2.2. /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ImagePruner の名前 |
- HTTP メソッド
-
DELETE - 説明
- ImagePruner を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ImagePruner を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ImagePruner を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ImagePruner を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
14.2.3. /apis/imageregistry.operator.openshift.io/v1/imagepruners/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ImagePruner の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ImagePruner のステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ImagePruner のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ImagePruner のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第15章 IngressController [operator.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
IngressController は、クラスターの管理対象の Ingress コントローラーを表します。コントローラーは、OpenShift Route および Kubernetes Ingress リソースにサービスを提供できます。
IngressController が作成されると、新しい Ingress コントローラーデプロイメントが作成され、Ingress または Route リソースを公開するサービスに外部トラフィックが到達できるようになります。このリソースを更新すると、新しい Ingress コントローラーのリビジョンが公開される可能性があるため、一般向けのネットワーク接続が中断される可能性があります。
https://kubernetes.io/docs/concepts/services-networking/ingress-controllers
可能な限り、プラットフォームに適したデフォルトが使用されます。詳細は、各フィールドを参照してください。
互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) で安定しています。
- 型
-
object
15.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 | |
|
|
| spec は、IngressController の望ましい動作の仕様です。 |
|
|
| status は、IngressController の最後に観察されたステータスです。 |
15.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、IngressController の望ましい動作の仕様です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| clientTLS は、クライアント証明書をリクエストおよび検証するための設定を指定します。これを使用して、エッジで終了したルートと再暗号化ルートの相互 TLS を有効にすることができます。 |
|
|
| defaultCertificate は、入力コントローラーによって提供されるデフォルトの証明書を含むシークレットへの参照です。ルートが独自の証明書を指定しない場合は、defaultCertificate が使用されます。 シークレットには以下のキーおよびデータが含まれている必要があります。 tls.crt: 証明書ファイルの内容 tls.key: キーファイルの内容 設定されていない場合は、ワイルドカード証明書が自動的に生成され、使用されます。この証明書は、ingress コントローラードメイン (およびサブドメイン) に対して有効であり、生成された証明書の CA は、クラスターのトラストストアに自動的に統合されます。 ワイルドカード証明書が複数の HTTP/2 対応ルート (ALPN を意味する) によって使用および共有されている場合、クライアント (つまり、特にブラウザー) は自由に開いている接続を再利用できます。これは、クライアントが別のルートへの接続を再利用できることを意味し、それは失敗する可能性があります。この動作は、一般に接続合体として知られています。 使用中の証明書 (生成されたものかユーザー指定されたものかを問わず) は、OpenShift の組み込み OAuth サーバーと自動的に統合されます。 |
|
|
| domain は、Ingress コントローラーによって提供される DNS 名であり、複数の機能を設定するために使用されます。 * LoadBalancerService エンドポイント公開ストラテジーの場合、domain は DNS レコードを設定するために使用されます。endpointPublishingStrategy を参照してください。 * 生成されたデフォルト証明書を使用する場合、証明書はドメインとそのサブドメインに対して有効です。defaultCertificate を参照してください。 * この値は、エンドユーザーが外部 DNS レコードのターゲット先を認識できるように、個々のルートのステータスに公開されます。 domain はすべての IngressController の中で一意である必要があり、更新することはできません。 空の場合、デフォルトは ingress.config.openshift.io/cluster.spec.domain になります。 |
|
|
| endpointPublishingStrategy は、入力コントローラーのエンドポイントを他のネットワークに公開したり、ロードバランサーの統合を有効にしたりするために使用されます。 設定されていない場合、デフォルトは infrastructure.config.openshift.io/cluster .status.platform に基づきます。 AWS: LoadBalancerService (External スコープ) Azure: LoadBalancerService (External スコープ) GCP: LoadBalancerService (External スコープ) IBMCloud: LoadBalancerService (External スコープ) AlibabaCloud: LoadBalancerService (External スコープ) Libvirt: HostNetwork その他のプラットフォームタイプ (None を含む) は、デフォルトで HostNetwork になります。 endpointPublishingStrategy を更新することはできません。 |
|
|
| httpCompression は、HTTP トラフィック圧縮のポリシーを定義します。デフォルトでは、HTTP 圧縮はありません。 |
|
|
| httpEmptyRequestsPolicy は、リクエストを受信する前に接続がタイムアウトした場合の HTTP 接続の処理方法を記述します。このフィールドに使用できる値は "Respond" および "Ignore" です。このフィールドが "Respond" に設定されている場合、ingress コントローラーは HTTP 400 または 408 応答を送信し、接続をログに記録し (アクセスログが有効な場合)、適切なメトリクスで接続をカウントします。フィールドが "Ignore" に設定されている場合、Ingress コントローラーは応答を送信せずに接続を閉じると、接続をログに記録するか、メトリクスを増分します。デフォルト値は "Respond" です。 通常、これらの接続はロードバランサーのヘルスプローブまたは Web ブラウザーの投機的接続 ("事前接続") からのものであり、無視しても問題ありません。ただし、これらのリクエストはネットワークエラーが原因である可能性もあるため、このフィールドを "Ignore" に設定すると、問題の検出と診断が妨げられる可能性があります。さらに、これらのリクエストはポートスキャンによって引き起こされる可能性があります。その場合、空のリクエストをログに記録すると、侵入の試みを検出するのに役立つ場合があります。 |
|
|
| httpErrorCodePages は、カスタムエラーページを含む設定マップを指定します。管理者は、openshift-config namespace にこの configmap を作成する必要があります。この設定マップには、"error-page-<error code>.http" の形式のキーが必要です。ここで、<error code> は HTTP エラーコードです。たとえば、"error-page-503.http" は、HTTP503 応答のエラーページを定義します。現在、カスタマイズできるのは 503 および 404 応答のエラーページのみです。configmap の各値は、HTTP ヘッダーを含む完全な応答である必要があります。例 -https://raw.githubusercontent.com/openshift/router/fadab45747a9b30cc3f0a4b41ad2871f95827a93/images/router/haproxy/conf/error-page-503.http (このフィールドが空の場合、入力コントローラーはデフォルトのエラーページを使用します)。 |
|
|
| httpHeaders は、HTTP ヘッダーのポリシーを定義します。 このフィールドが空の場合、デフォルト値が使用されます。 |
|
|
| idleConnectionTerminationPolicy は、HAProxy の idle-close-on-response オプションに直接マップされ、ソフトストップ (ルーターのリロード) 中に HAProxy がアイドル状態のフロントエンド接続を開いたままにするかどうかを制御します。 このフィールドに許可される値は、"Immediate" と "Deferred"。デフォルト値は "Immediate" です。 "Immediate" に設定すると、ルーターのリロード時にアイドル接続が直ちに閉じられます。これにより、ルートの変更が即座に伝播されますが、接続のリセットに敏感なクライアントに影響が出る可能性があります。 "Deferred" に設定すると、HAProxy はアイドル接続をすぐに閉じるのではなく、ソフトリロード中にアイドル接続を維持します。これらの接続は、次のいずれかが発生するまで開いたままになります。 - 接続で新しいリクエストが受信された場合。この場合、HAProxy はそれを古いプロセスで処理し、レスポンスを送信した後に接続を閉じます。
- HAProxy の - クライアントの keep-alive タイムアウトが期限切れになった場合。これにより、クライアントは接続を閉じます。 Deferred を設定すると、接続リセットを適切に処理しないクライアントまたはロードバランサーでのエラーを防ぐのに役立ちます。さらに、このオプションを使用すると、2.4 より前の HAProxy の動作を保持できます。HAProxy バージョン 2.2 (OpenShift バージョン 4.14 より前) では、ソフトリロード中にアイドル接続を維持することがデフォルトの動作でしたが、HAProxy 2.4 以降では、アイドル接続を直ちに閉じるようにデフォルトの動作が変更されました。 重要な考慮事項: - Deferred を使用すると、ルートの更新とルーターのリロード後に、各永続接続の最初のリクエストに一時的な不整合が発生します。このリクエストは、古い設定を使用して古い HAProxy プロセスによって処理されます。後続のリクエストでは、更新された設定が使用されます。 運用上の考慮事項: - リロード中にアイドル接続を開いたままにしておくと、特に頻繁にリロードが発生する環境では、接続が長時間アイドル状態のままになると、古い HAProxy プロセスが蓄積される可能性があります。 - Deferred が設定されている場合は、ルーター Pod 内の HAProxy プロセスの数の監視を検討してください。
- リソース枯渇を防ぐために、頻繁にリロードされる環境では、 |
|
|
| ロギングは、何をどこに記録するかについてパラメーターを定義します。このフィールドが空の場合、操作ログは有効になりますが、アクセスログは無効になります。 |
|
|
| namespaceSelector は、Ingress コントローラーによって提供される namespace セットをフィルターするために使用されます。これはシャードの実装に役立ちます。 設定されていない場合、デフォルトはフィルタリングなしです。 |
|
|
| nodePlacement は、Ingress コントローラーのスケジュールに対する明示的な制御を有効にします。 設定されていない場合、デフォルトが使用されます。詳細は、NodePlacement を参照してください。 |
|
|
| replicas は Ingress コントローラーレプリカの必要な数です。設定されていない場合、クラスターの config.openshift.io/v1/ingresses ステータスの defaultPlacement フィールドの値によってデフォルトが決まります。 replicas の値は、Infrastructure CR 内の選択されるフィールドの値に基づいて設定されます。defaultPlacement が ControlPlane に設定されている場合、選択されるフィールドは controlPlaneTopology になります。Workers に設定されている場合、選択されるフィールドは、infrastructureTopology になります。選択されるフィールドの値が SingleReplica か HighlyAvailable かに基づいて、レプリカはそれぞれ 1 または 2 に設定されます。 これらのデフォルトは変更される可能性があります。 |
|
|
| routeAdmission は、新しいルート要求を処理するためのポリシーを定義します (たとえば、namespace 全体で要求を許可または拒否します)。 空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の routeAdmission フィールドを参照してください。 |
|
|
| routeSelector は、Ingress コントローラーによって提供される Routes のセットをフィルターするために使用されます。これはシャードの実装に役立ちます。 設定されていない場合、デフォルトはフィルタリングなしです。 |
|
|
| tlsSecurityProfile は、Ingress コントローラーの TLS 接続の設定を指定します。 設定されていない場合、デフォルトは apiservers.config.openshift.io/cluster リソースに基づいています。 Old、Intermediate、および Modern のプロファイルタイプを使用する場合、有効なプロファイル設定はリリース間で変更される可能性があります。たとえば、リリース X.Y.Z にデプロイされた Intermediate プロファイルを使用する仕様がある場合、リリース X.Y.Z+1 へのアップグレードにより、新規のプロファイル設定が Ingress コントローラーに適用され、ロールアウトが生じる可能性があります。 |
|
|
| tuningOptions は、入力コントローラー Pod のパフォーマンスを調整するためのパラメーターを定義します。すべてのフィールドはオプションであり、設定されていない場合はそれぞれのデフォルトを使用します。詳細は、特定の tuningOptions フィールドを参照してください。 通常、tuningOptions 内でフィールドを設定することは推奨しません。デフォルト値は、ほとんどの設定に適しています。 |
|
| `` | unsupportedConfigOverrides を使用すると、サポートされていない設定オプションを指定できます。その使用はサポートされていません。 |
15.1.2. .spec.clientTLS リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientTLS は、クライアント証明書をリクエストおよび検証するための設定を指定します。これを使用して、エッジで終了したルートと再暗号化ルートの相互 TLS を有効にすることができます。
- 型
-
object - 必須
-
clientCA -
clientCertificatePolicy
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| allowedSubjectPatterns は、リクエストをフィルタリングするために有効なクライアント証明書の識別名と照合する必要がある正規表現のリストを指定します。正規表現は PCRE 構文を使用する必要があります。このリストが空の場合、フィルタリングは実行されません。リストが空でない場合は、少なくとも 1 つのパターンがクライアント証明書の識別名と一致する必要があります。一致しない場合、入力コントローラーは証明書を拒否して接続を拒否します。 |
|
|
| clientCA は、クライアントの証明書を検証するために使用する必要がある PEM でエンコードされた CA 証明書バンドルを含む設定マップを指定します。管理者は、openshift-config namespace にこの configmap を作成する必要があります。 |
|
|
| clientCertificatePolicy は、入力コントローラーがクライアントに証明書の提供を要求するかどうかを指定します。このフィールドは、"Required" または "Optional" の値を受け入れます。 入力コントローラーは、クライアント証明書でエッジが終了し、TLS ルートを再暗号化することのみをチェックすることに注意してください。クリアテキスト HTTP またはパススルー TLS ルートの証明書をチェックすることはできません。 |
15.1.3. .spec.clientTLS.clientCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientCA は、クライアントの証明書を検証するために使用する必要がある PEM でエンコードされた CA 証明書バンドルを含む設定マップを指定します。管理者は、openshift-config namespace にこの configmap を作成する必要があります。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される config map の metadata.name です |
15.1.4. .spec.defaultCertificate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
defaultCertificate は、入力コントローラーによって提供されるデフォルトの証明書を含むシークレットへの参照です。ルートが独自の証明書を指定しない場合は、defaultCertificate が使用されます。
シークレットには以下のキーおよびデータが含まれている必要があります。
tls.crt: certificate file contents tls.key: key file contents
tls.crt: certificate file contents tls.key: key file contentsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 設定されていない場合は、ワイルドカード証明書が自動的に生成され、使用されます。この証明書は、ingress コントローラードメイン (およびサブドメイン) に対して有効であり、生成された証明書の CA は、クラスターのトラストストアに自動的に統合されます。
ワイルドカード証明書が複数の HTTP/2 対応ルート (ALPN を意味する) によって使用および共有されている場合、クライアント (つまり、特にブラウザー) は自由に開いている接続を再利用できます。これは、クライアントが別のルートへの接続を再利用できることを意味し、それは失敗する可能性があります。この動作は、一般に接続合体として知られています。
使用中の証明書 (生成されたものかユーザー指定されたものかを問わず) は、OpenShift の組み込み OAuth サーバーと自動的に統合されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の名前。このフィールドは実質的には必須ですが、下位互換性のため空でもかまいません。ここで空の値を持つこの型のインスタンスは、ほぼ間違いなく間違っています。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
15.1.5. .spec.endpointPublishingStrategy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
endpointPublishingStrategy は、入力コントローラーのエンドポイントを他のネットワークに公開したり、ロードバランサーの統合を有効にしたりするために使用されます。
設定されていない場合、デフォルトは infrastructure.config.openshift.io/cluster .status.platform に基づきます。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow その他のプラットフォームタイプ (None を含む) は、デフォルトで HostNetwork になります。
endpointPublishingStrategy を更新することはできません。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| hostNetwork は、HostNetwork エンドポイント公開戦略のパラメーターを保持します。タイプが HostNetwork の場合にのみ存在します。 |
|
|
| loadBalancer は、ロードバランサーのパラメーターを保持します。タイプが LoadBalancerService の場合にのみ存在します。 |
|
|
| nodePort は、NodePortService エンドポイント公開戦略のパラメーターを保持します。タイプが NodePortService の場合にのみ存在します。 |
|
|
| private は、プライベートエンドポイント公開戦略のパラメーターを保持します。タイプがプライベートの場合にのみ存在します。 |
|
|
| type は、使用する公開戦略です。有効な値は以下のとおりです。 * LoadBalancerService Kubernetes LoadBalancer サービスを使用して Ingress コントローラーを公開します。 この設定では、Ingress コントローラーのデプロイメントはコンテナーのネットワークを使用します。LoadBalancer サービスは、デプロイメントを公開するために作成されます。 参照: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer ドメインが設定されている場合、ワイルドカード DNS レコードは LoadBalancer サービスの外部名を参照するように管理されます。DNS レコードは、dns.config.openshift.io/cluster.spec.publicZone および.spec.privateZone で定義された DNS ゾーンでのみ管理されます。 ワイルドカード DNS 管理は現在、AWS、Azure、および GCP プラットフォームでのみサポートされています。 * HostNetwork Ingress コントローラーがデプロイされているノードポートに Ingress コントローラーを公開します。 この設定では、Ingress コントローラーのデプロイメントはノードポート 80 および 443 にバインドされたホストネットワークを使用します。ユーザーは、ノードポート経由で Ingress コントローラーを公開するための外部ロードバランサーを設定する必要があります。 * Private Ingress コントローラーを公開しません。 この設定では、Ingress コントローラーのデプロイメントはコンテナーネットワークを使用し、明示的に公開されません。ユーザーは Ingress コントローラーを手動で公開する必要があります。 * NodePortService Kubernetes NodePort サービスを使用して Ingress コントローラーを公開します。 この設定では、Ingress コントローラーのデプロイメントはコンテナーのネットワークを使用します。デプロイメントを公開するために NodePort Service が作成されます。特定のノードポートは、OpenShift によって動的に割り当てられます。ただし、静的ポート割り当てをサポートするために、マネージド NodePort サービスのノードポートフィールドへのユーザーの変更は保持されます。 |
15.1.6. .spec.endpointPublishingStrategy.hostNetwork リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- hostNetwork は、HostNetwork エンドポイント公開戦略のパラメーターを保持します。タイプが HostNetwork の場合にのみ存在します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| httpPort は、HTTP リクエストをリッスンするために使用するホスト上のポートです。ポート 80 がすでに使用されている場合は、このフィールドを設定する必要があります。値がクラスターの NodePort 範囲と重ならないようにしてください。値が 0 の場合、または指定されていない場合は、デフォルトで 80 になります。 |
|
|
| httpsPort は、HTTPS リクエストをリッスンするために使用するホスト上のポートです。ポート 443 がすでに使用されている場合は、このフィールドを設定する必要があります。値がクラスターの NodePort 範囲と重ならないようにしてください。値が 0 の場合、または指定されていない場合は、デフォルトで 443 になります。 |
|
|
| プロトコルは、IngressController が着信接続でプレーン TCP を使用することを期待するかどうか、または IngressController が PROXY プロトコルを期待するかどうかを指定します。 PROXY プロトコルは、クライアント接続を IngressController に転送するときに、それらの接続の送信元アドレスを通信するためにそれをサポートするロードバランサーで使用できます。PROXY プロトコルを使用すると、IngressController は、HTTP ヘッダーとログでロードバランサーのアドレスを報告する代わりに、これらの送信元アドレスを報告できます。IngressController で PROXY プロトコルを有効にすると、PROXY プロトコルを使用して接続を IngressController に転送するロードバランサーを使用していない場合、接続が失敗することに注意してください。PROXY プロトコルの詳細は、http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt を参照してください。 このフィールドでは、次の値が有効です。 * 空の文字列。* "TCP"。* "PROXY"。 空の文字列はデフォルトを指定します。これは PROXY プロトコルなしの TCP です。デフォルトは変更される可能性があることに注意してください。 |
|
|
| statsPort は、ルーターからの統計情報を公開するホスト上のポートです。値がクラスターの NodePort 範囲と重ならないようにしてください。この IngressController に接続を転送するように外部ロードバランサーが設定されている場合、ロードバランサーはヘルスチェックにこのポートを使用する必要があります。ロードバランサーは、特定のノード上のこのポートにパス /healthz/ready を使用して HTTP プローブを送信し、Ingress Controller がノード上でトラフィックを受信する準備ができているかどうかを確認できます。適切に動作させるために、ヘルスチェックによって準備完了が報告されるまで、ロードバランサーからノードにトラフィックを転送しないでください。ロードバランサーは、/healthz/ready が準備完了ではないことを報告し始めてから 45 秒以内にリクエストの転送を停止する必要があります。5 - 10 秒ごとにプローブし、タイムアウトを 5 秒に設定し、正常または異常を判定するしきい値として、成功または失敗したリクエストの数を 2 つに設定してください。これらは十分にテストされた値です。値が 0 の場合、または指定されていない場合は、デフォルトで 1936 になります。 |
15.1.7. .spec.endpointPublishingStrategy.loadBalancer リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- loadBalancer は、ロードバランサーのパラメーターを保持します。タイプが LoadBalancerService の場合にのみ存在します。
- 型
-
object - 必須
-
dnsManagementPolicy -
scope
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | allowedSourceRanges は、ロードバランサーへのアクセスを制限する IP アドレス範囲の許可リストを指定します。各範囲は CIDR 表記を使用して指定する必要があります (例: "10.0.0.0/8" または "fd00::/8")。範囲を指定しないと、IPv4 の場合は "0.0.0.0/0"、IPv6 の場合は "::/0" がデフォルトで使用され、すべての送信元アドレスが許可されます。 allowedSourceRanges フィールドがない以前のバージョンの OpenShift からの移行を容易にするために、"openshift-ingress" namespace の "router-<ingresscontroller name>" サービスに service.beta.kubernetes.io/load-balancer-source-ranges アノテーションを設定できます。このアノテーションは、OpenShift 4.12 で allowedSourceRanges が空の場合に有効になります。 |
|
|
| dnsManagementPolicy は、ロードバランサーサービスに関連付けられたワイルドカード DNS レコードのライフサイクルを Ingress Operator によって管理するかどうかを示します。デフォルトは Managed です。有効な値は Managed と Unmanaged です。 |
|
|
| providerParameters は、基盤となるインフラストラクチャープロバイダーに固有の必要なロードバランサー情報を保持します。 空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の providerParameters フィールドを参照してください。 |
|
|
| scope は、ロードバランサーが公開されるスコープを示します。可能な値は "External" と "Internal" です。 |
15.1.8. .spec.endpointPublishingStrategy.loadBalancer.providerParameters リンクのコピーリンクがクリップボードにコピーされました!
- 説明
providerParameters は、基盤となるインフラストラクチャープロバイダーに固有の必要なロードバランサー情報を保持します。
空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の providerParameters フィールドを参照してください。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| aws は、AWS のロードバランサーに固有の設定を指定します。 空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の aws フィールドを参照してください。 |
|
|
| gcp は、GCP のロードバランサーに固有の設定を指定します。 空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の gcp フィールドを参照してください。 |
|
|
| ibm は、IBM Cloud のロードバランサーに固有の設定を指定します。 空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の ibm フィールドを参照してください。 |
|
|
| openstack は、OpenStack ロードバランサーに固有の設定を指定します。 空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の openstack フィールドを参照してください。 |
|
|
| type は、ロードバランサーの基盤となるインフラストラクチャープロバイダーです。許可される値は、"AWS"、"Azure"、"BareMetal"、"GCP"、"IBM"、"Nutanix"、"OpenStack"、および "VSphere" です。 |
15.1.9. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws リンクのコピーリンクがクリップボードにコピーされました!
- 説明
aws は、AWS のロードバランサーに固有の設定を指定します。
空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の aws フィールドを参照してください。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| classicLoadBalancerParameters は、AWS クラシックロードバランサーの設定パラメーターを保持します。タイプがクラシックの場合にのみ表示されます。 |
|
|
| networkLoadBalancerParameters は、AWS ネットワークロードバランサーの設定パラメーターを保持します。タイプが NLB の場合にのみ存在します。 |
|
|
| type は、イングレスコントローラー用にインスタンス化する AWS ロードバランサーのタイプです。 有効な値は以下のとおりです。 *"Classic": トランスポート層 (TCP/SSL) またはアプリケーション層 (HTTP/HTTPS) のいずれかでルーティングを決定する Classic Load Balancer。詳細は、以下を参照してください。 https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb * "NLB": トランスポート層 (TCP/SSL) でルーティングを決定する Network Load Balancer。詳細は、以下を参照してください。 https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb |
15.1.10. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- classicLoadBalancerParameters は、AWS クラシックロードバランサーの設定パラメーターを保持します。タイプがクラシックの場合にのみ表示されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| connectionIdleTimeout は、ロードバランサーが接続を閉じるまでに接続がアイドル状態になることができる最大時間を指定します。値は時間間隔の値として解析可能である必要があります。https://pkg.go.dev/time#ParseDuration を参照してください。値が nil またはゼロの場合、指定なしとみなされ、デフォルト値が使用されます。このフィールドのデフォルト値は 60s です。このデフォルトは変更される可能性があります。 |
|
|
| subnets は、ロードバランサーの割り当て先のサブネットを指定します。サブネットは ID または名前のいずれかで指定できます。サブネットの合計数は 10 に制限されています。 ロードバランサーにサブネットをプロビジョニングするには、各サブネットが存在し、各サブネットが異なるアベイラビリティーゾーンからのものである必要がありあす。また、新しい値を取得するためにロードバランサーサービスを再作成する必要があります。 仕様から省略すると、各アベイラビリティーゾーンのサブネットが自動検出されます。自動検出されたサブネットは、IngressController オブジェクトのステータスでは報告されません。 |
15.1.11. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.classicLoadBalancer.subnets リンクのコピーリンクがクリップボードにコピーされました!
- 説明
subnets は、ロードバランサーの割り当て先のサブネットを指定します。サブネットは ID または名前のいずれかで指定できます。サブネットの合計数は 10 に制限されています。
ロードバランサーにサブネットをプロビジョニングするには、各サブネットが存在し、各サブネットが異なるアベイラビリティーゾーンからのものである必要がありあす。また、新しい値を取得するためにロードバランサーサービスを再作成する必要があります。
仕様から省略すると、各アベイラビリティーゾーンのサブネットが自動検出されます。自動検出されたサブネットは、IngressController オブジェクトのステータスでは報告されません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ids は、サブネット ID による AWS サブネットのリストを指定します。サブネット ID は、"subnet-" で始まり、英数字のみで構成され、ちょうど 24 文字の長さで、一意である必要があります。ID と名前で指定されたサブネットの合計数は、10 以下である必要があります。 |
|
|
| names は、サブネット名による AWS サブネットのリストを指定します。サブネット名は、"subnet-" で始まらず、コンマを含まず、256 文字未満の長さで、一意である必要があります。ID および名前で指定されたサブネットの合計数は、10 以下である必要があります。 |
15.1.12. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- networkLoadBalancerParameters は、AWS ネットワークロードバランサーの設定パラメーターを保持します。タイプが NLB の場合にのみ存在します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| eipAllocations は、Network Load Balancer に割り当てられる Elastic IP (EIP) アドレスの ID のリストです。以下の制限が適用されます。 eipAllocations は外部スコープでのみ使用でき、内部スコープでは使用できません。EIP は 1 つの IngressController にのみ割り当てることができます。EIP 割り当ての数は、ロードバランサーに使用されるサブネットの数と同じである必要があります。EIP 割り当ては、それぞれ一意である必要があります。最大 10 個の EIP 割り当てが許可されます。 Elastic IP アドレスの設定、特性、制限に関する一般的な情報は、https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html を参照してください。 |
|
|
| subnets は、ロードバランサーの割り当て先のサブネットを指定します。サブネットは ID または名前のいずれかで指定できます。サブネットの合計数は 10 に制限されています。 ロードバランサーにサブネットをプロビジョニングするには、各サブネットが存在し、各サブネットが異なるアベイラビリティーゾーンからのものである必要がありあす。また、新しい値を取得するためにロードバランサーサービスを再作成する必要があります。 仕様から省略すると、各アベイラビリティーゾーンのサブネットが自動検出されます。自動検出されたサブネットは、IngressController オブジェクトのステータスでは報告されません。 |
15.1.13. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.aws.networkLoadBalancer.subnets リンクのコピーリンクがクリップボードにコピーされました!
- 説明
subnets は、ロードバランサーの割り当て先のサブネットを指定します。サブネットは ID または名前のいずれかで指定できます。サブネットの合計数は 10 に制限されています。
ロードバランサーにサブネットをプロビジョニングするには、各サブネットが存在し、各サブネットが異なるアベイラビリティーゾーンからのものである必要がありあす。また、新しい値を取得するためにロードバランサーサービスを再作成する必要があります。
仕様から省略すると、各アベイラビリティーゾーンのサブネットが自動検出されます。自動検出されたサブネットは、IngressController オブジェクトのステータスでは報告されません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ids は、サブネット ID による AWS サブネットのリストを指定します。サブネット ID は、"subnet-" で始まり、英数字のみで構成され、ちょうど 24 文字の長さで、一意である必要があります。ID と名前で指定されたサブネットの合計数は、10 以下である必要があります。 |
|
|
| names は、サブネット名による AWS サブネットのリストを指定します。サブネット名は、"subnet-" で始まらず、コンマを含まず、256 文字未満の長さで、一意である必要があります。ID および名前で指定されたサブネットの合計数は、10 以下である必要があります。 |
15.1.14. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.gcp リンクのコピーリンクがクリップボードにコピーされました!
- 説明
gcp は、GCP のロードバランサーに固有の設定を指定します。
空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の gcp フィールドを参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| clientAccess は、内部ロードバランサーのクライアントアクセスがどのように制限されるかを記述します。 有効な値は次のとおりです。* "Global": グローバルクライアントアクセスで内部ロードバランサーを指定すると、VPC 内の任意のリージョンのクライアントがロードバランサーと通信できるようになります。 https://cloud.google.com/kubernetes-engine/docs/how-to/internal-load-balancing#global_access * "Local": Local クライアントアクセスを使用して内部ロードバランサーを指定すると、GCP ロードバランサーと同じリージョン (および VPC) 内のクライアントのみがロードバランサーと通信できるようになります。これがデフォルトの動作であることに注意してください。 https://cloud.google.com/load-balancing/docs/internal#client_access |
15.1.15. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.ibm リンクのコピーリンクがクリップボードにコピーされました!
- 説明
ibm は、IBM Cloud のロードバランサーに固有の設定を指定します。
空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の ibm フィールドを参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| protocol は、ロードバランサーが PROXY プロトコルを使用して IngressController に接続を転送するかどうかを指定します。https://cloud.ibm.com/docs/containers?topic=containers-vpc-lbaas の 「service.kubernetes.io/ibm-load-balancer-cloud-provider-enable-features: "proxy-protocol"」を参照してください。 PROXY プロトコルは、クライアント接続を IngressController に転送するときに、それらの接続の送信元アドレスを通信するためにそれをサポートするロードバランサーで使用できます。PROXY プロトコルを使用すると、IngressController は、HTTP ヘッダーとログでロードバランサーのアドレスを報告する代わりに、これらの送信元アドレスを報告できます。IngressController で PROXY プロトコルを有効にすると、PROXY プロトコルを使用して接続を IngressController に転送するロードバランサーを使用していない場合、接続が失敗することに注意してください。PROXY プロトコルの詳細は、http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt を参照してください。 protocol の有効な値は、TCP、PROXY です (省略可能)。省略すると、指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在のデフォルトは、PROXY プロトコルが有効でない TCP です。 |
15.1.16. .spec.endpointPublishingStrategy.loadBalancer.providerParameters.openstack リンクのコピーリンクがクリップボードにコピーされました!
- 説明
openstack は、OpenStack ロードバランサーに固有の設定を指定します。
空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の openstack フィールドを参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| floatingIP は、ロードバランサーが使用する IP アドレスを指定します。指定しない場合は、OpenStack クラウドプロバイダーによって IP アドレスがランダムに割り当てられます。指定する場合、Floating IP を事前に作成する必要があります。指定された値が Floating IP でないか、すでに要求されている場合、OpenStack クラウドプロバイダーがロードバランサーをプロビジョニングできません。このフィールドは、IngressController に外部スコープがある場合にのみ使用できます。この値は有効な IPv4 または IPv6 アドレスである必要があります。 |
15.1.17. .spec.endpointPublishingStrategy.nodePort リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- nodePort は、NodePortService エンドポイント公開戦略のパラメーターを保持します。タイプが NodePortService の場合にのみ存在します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| プロトコルは、IngressController が着信接続でプレーン TCP を使用することを期待するかどうか、または IngressController が PROXY プロトコルを期待するかどうかを指定します。 PROXY プロトコルは、クライアント接続を IngressController に転送するときに、それらの接続の送信元アドレスを通信するためにそれをサポートするロードバランサーで使用できます。PROXY プロトコルを使用すると、IngressController は、HTTP ヘッダーとログでロードバランサーのアドレスを報告する代わりに、これらの送信元アドレスを報告できます。IngressController で PROXY プロトコルを有効にすると、PROXY プロトコルを使用して接続を IngressController に転送するロードバランサーを使用していない場合、接続が失敗することに注意してください。PROXY プロトコルの詳細は、http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt を参照してください。 このフィールドでは、次の値が有効です。 * 空の文字列。* "TCP"。* "PROXY"。 空の文字列はデフォルトを指定します。これは PROXY プロトコルなしの TCP です。デフォルトは変更される可能性があることに注意してください。 |
15.1.18. .spec.endpointPublishingStrategy.private リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- private は、プライベートエンドポイント公開戦略のパラメーターを保持します。タイプがプライベートの場合にのみ存在します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| プロトコルは、IngressController が着信接続でプレーン TCP を使用することを期待するかどうか、または IngressController が PROXY プロトコルを期待するかどうかを指定します。 PROXY プロトコルは、クライアント接続を IngressController に転送するときに、それらの接続の送信元アドレスを通信するためにそれをサポートするロードバランサーで使用できます。PROXY プロトコルを使用すると、IngressController は、HTTP ヘッダーとログでロードバランサーのアドレスを報告する代わりに、これらの送信元アドレスを報告できます。IngressController で PROXY プロトコルを有効にすると、PROXY プロトコルを使用して接続を IngressController に転送するロードバランサーを使用していない場合、接続が失敗することに注意してください。PROXY プロトコルの詳細は、http://www.haproxy.org/download/2.2/doc/proxy-protocol.txt を参照してください。 このフィールドでは、次の値が有効です。 * 空の文字列。* "TCP"。* "PROXY"。 空の文字列はデフォルトを指定します。これは PROXY プロトコルなしの TCP です。デフォルトは変更される可能性があることに注意してください。 |
15.1.19. .spec.httpCompression リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- httpCompression は、HTTP トラフィック圧縮のポリシーを定義します。デフォルトでは、HTTP 圧縮はありません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| mimeTypes は、圧縮を適用する必要のある MIME タイプのリストです。このリストは空にすることもできます。その場合、Ingress Controller は圧縮を適用しません。 注記: すべての MIME タイプが圧縮の恩恵を受けるわけではありませんが、それでも指示があれば、HAProxy がリソースを使用して圧縮を試みます。一般的に、テキスト (html、css、js など) 形式は、圧縮の恩恵を受けます。しかし、すでに圧縮されている形式 (イメージ、オーディオ、ビデオなど) は、再度圧縮するのにかかる時間と CPU の割に、あまり恩恵がありません。https://joehonton.medium.com/the-gzip-penalty-d31bd697f1a2 を参照してください。 |
15.1.20. .spec.httpErrorCodePages リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- httpErrorCodePages は、カスタムエラーページを含む設定マップを指定します。管理者は、openshift-config namespace にこの configmap を作成する必要があります。この設定マップには、"error-page-<error code>.http" の形式のキーが必要です。ここで、<error code> は HTTP エラーコードです。たとえば、"error-page-503.http" は、HTTP503 応答のエラーページを定義します。現在、カスタマイズできるのは 503 および 404 応答のエラーページのみです。configmap の各値は、HTTP ヘッダーを含む完全な応答である必要があります。例 -https://raw.githubusercontent.com/openshift/router/fadab45747a9b30cc3f0a4b41ad2871f95827a93/images/router/haproxy/conf/error-page-503.http (このフィールドが空の場合、入力コントローラーはデフォルトのエラーページを使用します)。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される config map の metadata.name です |
15.1.21. .spec.httpHeaders リンクのコピーリンクがクリップボードにコピーされました!
- 説明
httpHeaders は、HTTP ヘッダーのポリシーを定義します。
このフィールドが空の場合、デフォルト値が使用されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
actions は、ヘッダーとその値を変更するためのオプションを指定します。このオプションは、クリアテキスト HTTP 接続と、入力コントローラーが暗号化を終了するセキュア HTTP 接続 (つまり、エッジ終了または再暗号化接続) にのみ適用されることに注意してください。TLS パススルー接続の場合、ヘッダーを変更することはできません。HSTS ( |
|
|
| forwardedHeaderPolicy は、IngressController が Forwarded、X-Forwarded-For、X-Forwarded-Host、X-Forwarded-Port、X-Forwarded-Proto、および X-Forwarded-Proto-Version HTTP ヘッダーをいつどのように設定するかを指定します。値は次のいずれかになります。 * "Append" は、IngressController が既存のヘッダーを保持しながらヘッダーを追加することを指定します。 * "Replace" は、IngressController がヘッダーを設定し、既存の Forwarded または X-Forwarded-*ヘッダーを置き換えることを指定します。 * "IfNone"。ヘッダーがまだ設定されていない場合、IngressController がヘッダーを設定することを指定します。 * "Never"。IngressController がヘッダーを設定せず、既存のヘッダーを保持することを指定します。 デフォルトでは、ポリシーは "Append" です。 |
|
| `` | headerNameCaseAdjustments は、HTTP ヘッダー名に適用できる大文字小文字の調整を指定します。それぞれの調整は、必要な大文字化を指定して HTTP ヘッダー名として指定されます。たとえば、"X-Forwarded-For" を指定すると、指定された大文字化を有効にするために "x-forwarded-for" HTTP ヘッダーを調整する必要があることを示唆できます。 これらの調整は、クリアテキスト、edge-terminated、および re-encrypt ルートにのみ適用され、HTTP/1 を使用する場合にのみ適用されます。 リクエストヘッダーの場合、これらの調整は haproxy.router.openshift.io/h1-adjust-case=true アノテーションを持つルートに対してのみ適用されます。応答ヘッダーの場合、これらの調整はすべての HTTP 応答に適用されます。 このフィールドが空の場合、リクエストヘッダーは調整されません。 |
|
|
| uniqueId は、入力コントローラーが着信 HTTP リクエストに注入する必要があるカスタム HTTP ヘッダーの設定を記述します。通常、このヘッダーは、HTTP リクエストに固有の値を持つように設定されます。ヘッダーは、アプリケーションで使用したり、アクセスログに含めたりして、個々の HTTP リクエストのトレースを容易にすることができます。 このフィールドが空の場合、そのようなヘッダーはリクエストに注入されません。 |
15.1.22. .spec.httpHeaders.actions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
actions は、ヘッダーとその値を変更するためのオプションを指定します。このオプションは、クリアテキスト HTTP 接続と、入力コントローラーが暗号化を終了するセキュア HTTP 接続 (つまり、エッジ終了または再暗号化接続) にのみ適用されることに注意してください。TLS パススルー接続の場合、ヘッダーを変更することはできません。HSTS (
Strict-Transport-Security) ヘッダーの設定は、actions 経由ではサポートされていません。Strict-Transport-Securityは、必ず "haproxy.router.openshift.io/hsts_header" ルートアノテーションを使用して、Ingress.Spec.RequiredHSTSPolicies で指定されたポリシーに従って設定する必要があります。ここで定義したアクションは、cache-control、spec.clientTLS、spec.httpHeaders.forwardedHeaderPolicy、spec.httpHeaders.uniqueId、spec.httpHeaders.headerNameCaseAdjustments など、他のフィールドに関連するアクションの後に適用されます。HTTP リクエストヘッダーの場合、ルートの spec.httpHeaders.actions で指定されたアクションは、IngressController の spec.httpHeaders.actions フィールドで指定されたアクションの後に実行されます。HTTP レスポンスヘッダーの場合、IngressController の spec.httpHeaders.actions で指定されたアクションは、ルートの spec.httpHeaders.actions フィールドで指定されたアクションの後に実行されます。この API を使用して設定されたヘッダーを、アクセスログで使用するために取得することはできません。ヘッダー名 Strict-Transport-Security、Proxy、Host、Cookie、Set-Cookie は予約されており、この API 経由で変更することはできません。動的な値を補間した 後 に追加されたすべてのヘッダーの合計サイズが、IngressController の spec.tuningOptions.headerBufferMaxRewriteBytes の値を超えてはならないことに注意してください。詳細は、該当する API フィールドのドキュメントを参照してください。 - 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
request は、変更する HTTP リクエストヘッダーのリストです。ここで定義したアクションにより、Ingress Controller を通過するすべてのリクエストのリクエストヘッダーが変更されます。このアクションは、すべてのルート、つまりクラスター内で定義された Ingress Controller によって処理されるすべての接続に適用されます。リクエストヘッダーの IngressController アクションは、ルートアクションの前に実行されます。現在、actions では、 |
|
|
| IngressControllerHTTPHeader は、HTTP ヘッダーを設定または削除するための設定を指定します。 |
|
|
|
response は、変更する HTTP レスポンスヘッダーのリストです。ここで定義したアクションにより、Ingress Controller を通過するすべてのリクエストのレスポンスヘッダーが変更されます。このアクションは、すべてのルート、つまりクラスター内で定義された Ingress Controller によって処理されるすべての接続に適用されます。レスポンスヘッダーの IngressController アクションは、ルートアクションの後に実行されます。現在、actions では、 |
|
|
| IngressControllerHTTPHeader は、HTTP ヘッダーを設定または削除するための設定を指定します。 |
15.1.23. .spec.httpHeaders.actions.request リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
request は、変更する HTTP リクエストヘッダーのリストです。ここで定義したアクションにより、Ingress Controller を通過するすべてのリクエストのリクエストヘッダーが変更されます。このアクションは、すべてのルート、つまりクラスター内で定義された Ingress Controller によって処理されるすべての接続に適用されます。リクエストヘッダーの IngressController アクションは、ルートアクションの前に実行されます。現在、actions では、
SetまたはDeleteをヘッダー値として定義できます。アクションは、このリストで定義した順序で適用されます。最大 20 個のリクエストヘッダーアクションを設定できます。使用できるサンプルフェッチャーは、"req.hdr" と "ssl_c_der" です。使用できるコンバーターは、"lower" と "base64" です。ヘッダー値の例は、"%[req.hdr(X-target),lower]"、"%{+Q}[ssl_c_der,base64]" などです。 - 型
-
array
15.1.24. .spec.httpHeaders.actions.request[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- IngressControllerHTTPHeader は、HTTP ヘッダーを設定または削除するための設定を指定します。
- 型
-
object - 必須
-
action -
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| action は、ヘッダーの設定や削除など、ヘッダーに対して実行するアクションを指定します。 |
|
|
| name は、アクション実行対象のヘッダーの名前を指定します。値は、RFC 2616 セクション 4.2 で定義されている有効な HTTP ヘッダー名である必要があります。名前は、英数字と特殊文字 "-!#$%&'*+.^_`" のみで構成する必要があります。ヘッダー名 Strict-Transport-Security、Proxy、Host、Cookie、Set-Cookie は予約されており、この API 経由で変更することはできません。255 文字以内の長さである必要があります。ヘッダー名は一意である必要があります。 |
15.1.25. .spec.httpHeaders.actions.request[].action リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- action は、ヘッダーの設定や削除など、ヘッダーに対して実行するアクションを指定します。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| set は、HTTP ヘッダーの設定方法を指定します。このフィールドは、type が Set の場合は必須です。それ以外の場合は禁止されます。 |
|
|
| type は、ヘッダーに適用するアクションのタイプを定義します。使用できる値は、Set または Delete です。Set を使用すると、HTTP リクエストヘッダーとレスポンスヘッダーを設定できます。Delete を使用すると、HTTP リクエストヘッダーとレスポンスヘッダーを削除できます。 |
15.1.26. .spec.httpHeaders.actions.request[].action.set リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- set は、HTTP ヘッダーの設定方法を指定します。このフィールドは、type が Set の場合は必須です。それ以外の場合は禁止されます。
- 型
-
object - 必須
-
value
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| value は、ヘッダー値を指定します。動的な値を追加できます。値は、http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 で定義されている HAProxy 形式の文字列として解釈され、HAProxy の %[] 構文を使用できます。または、https://datatracker.ietf.org/doc/html/rfc7230#section-3.2 で定義されている有効な HTTP ヘッダー値である必要があります。このフィールドの値は、16384 文字以内の長さにする必要があります。動的な値を補間した 後 に追加されたすべてのヘッダーの合計サイズが、IngressController の spec.tuningOptions.headerBufferMaxRewriteBytes の値を超えてはならないことに注意してください。 |
15.1.27. .spec.httpHeaders.actions.response リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
response は、変更する HTTP レスポンスヘッダーのリストです。ここで定義したアクションにより、Ingress Controller を通過するすべてのリクエストのレスポンスヘッダーが変更されます。このアクションは、すべてのルート、つまりクラスター内で定義された Ingress Controller によって処理されるすべての接続に適用されます。レスポンスヘッダーの IngressController アクションは、ルートアクションの後に実行されます。現在、actions では、
SetまたはDeleteをヘッダー値として定義できます。アクションは、このリストで定義した順序で適用されます。最大 20 個のレスポンスヘッダーアクションを設定できます。使用できるサンプルフェッチャーは、"res.hdr" と "ssl_c_der" です。使用できるコンバーターは、"lower" と "base64" です。ヘッダー値の例は、"%[res.hdr(X-target),lower]"、"%{+Q}[ssl_c_der,base64]" などです。 - 型
-
array
15.1.28. .spec.httpHeaders.actions.response[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- IngressControllerHTTPHeader は、HTTP ヘッダーを設定または削除するための設定を指定します。
- 型
-
object - 必須
-
action -
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| action は、ヘッダーの設定や削除など、ヘッダーに対して実行するアクションを指定します。 |
|
|
| name は、アクション実行対象のヘッダーの名前を指定します。値は、RFC 2616 セクション 4.2 で定義されている有効な HTTP ヘッダー名である必要があります。名前は、英数字と特殊文字 "-!#$%&'*+.^_`" のみで構成する必要があります。ヘッダー名 Strict-Transport-Security、Proxy、Host、Cookie、Set-Cookie は予約されており、この API 経由で変更することはできません。255 文字以内の長さである必要があります。ヘッダー名は一意である必要があります。 |
15.1.29. .spec.httpHeaders.actions.response[].action リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- action は、ヘッダーの設定や削除など、ヘッダーに対して実行するアクションを指定します。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| set は、HTTP ヘッダーの設定方法を指定します。このフィールドは、type が Set の場合は必須です。それ以外の場合は禁止されます。 |
|
|
| type は、ヘッダーに適用するアクションのタイプを定義します。使用できる値は、Set または Delete です。Set を使用すると、HTTP リクエストヘッダーとレスポンスヘッダーを設定できます。Delete を使用すると、HTTP リクエストヘッダーとレスポンスヘッダーを削除できます。 |
15.1.30. .spec.httpHeaders.actions.response[].action.set リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- set は、HTTP ヘッダーの設定方法を指定します。このフィールドは、type が Set の場合は必須です。それ以外の場合は禁止されます。
- 型
-
object - 必須
-
value
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| value は、ヘッダー値を指定します。動的な値を追加できます。値は、http://cbonte.github.io/haproxy-dconv/2.6/configuration.html#8.2.6 で定義されている HAProxy 形式の文字列として解釈され、HAProxy の %[] 構文を使用できます。または、https://datatracker.ietf.org/doc/html/rfc7230#section-3.2 で定義されている有効な HTTP ヘッダー値である必要があります。このフィールドの値は、16384 文字以内の長さにする必要があります。動的な値を補間した 後 に追加されたすべてのヘッダーの合計サイズが、IngressController の spec.tuningOptions.headerBufferMaxRewriteBytes の値を超えてはならないことに注意してください。 |
15.1.31. .spec.httpHeaders.uniqueId リンクのコピーリンクがクリップボードにコピーされました!
- 説明
uniqueId は、入力コントローラーが着信 HTTP リクエストに注入する必要があるカスタム HTTP ヘッダーの設定を記述します。通常、このヘッダーは、HTTP リクエストに固有の値を持つように設定されます。ヘッダーは、アプリケーションで使用したり、アクセスログに含めたりして、個々の HTTP リクエストのトレースを容易にすることができます。
このフィールドが空の場合、そのようなヘッダーはリクエストに注入されません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| format は、注入された HTTP ヘッダーの値の形式を指定します。名前を指定しない限り、このフィールドは効果がありません。HAProxy ベースの入力コントローラーの実装の場合、この形式は HTTP ログ形式と同じ構文を使用します。フィールドが空の場合、デフォルト値は "%{+X}o\\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid" です。対応する HAProxy のドキュメント (http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3) を参照してください。 |
|
|
| name は、入力コントローラーが HTTP リクエストに注入する HTTP ヘッダーの名前 (たとえば、"unique-id") を指定します。フィールドの値は、RFC2616 セクション 4.2 で定義されている有効な HTTP ヘッダー名である必要があります。フィールドが空の場合、ヘッダーは注入されません。 |
15.1.32. .spec.logging リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ロギングは、何をどこに記録するかについてパラメーターを定義します。このフィールドが空の場合、操作ログは有効になりますが、アクセスログは無効になります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| アクセスは、クライアントリクエストをログに記録する方法を記述します。 このフィールドが空の場合、アクセスロギングは無効になります。 |
15.1.33. .spec.logging.access リンクのコピーリンクがクリップボードにコピーされました!
- 説明
アクセスは、クライアントリクエストをログに記録する方法を記述します。
このフィールドが空の場合、アクセスロギングは無効になります。
- 型
-
object - 必須
-
destination
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 宛先はアクセスログの移動先です。 |
|
| `` | httpCaptureCookies は、アクセスログにキャプチャする必要がある HTTP Cookie を指定します。このフィールドが空の場合、Cookie はキャプチャされません。 |
|
|
| httpCaptureHeaders は、アクセスログにキャプチャする必要がある HTTP ヘッダーを定義します。このフィールドが空の場合、ヘッダーはキャプチャされません。 このオプションは、クリアテキスト HTTP 接続と、入力コントローラーが暗号化を終了するセキュア HTTP 接続 (つまり、エッジ終了または再暗号化接続) にのみ適用されることに注意してください。TLS パススルー接続のヘッダーをキャプチャすることはできません。 |
|
|
| httpLogFormat は、HTTP リクエストのログメッセージの形式を指定します。 このフィールドが空の場合、ログメッセージは実装のデフォルト HTTP ログ形式を使用します。HAProxy のデフォルトの HTTP ログ形式は、HAProxy のドキュメント http://cbonte.github.io/haproxy-dconv/2.0/configuration.html#8.2.3 を参照してください。 この形式は、クリアテキスト HTTP 接続と、Ingress コントローラーが暗号化を終端するセキュア HTTP 接続 (つまり、エッジ終端または再暗号化接続) にのみ適用されることに注意してください。TLS パススルー接続のログ形式には影響しません。 |
|
|
| logEmptyRequests は、リクエストを受信しない接続をログに記録する方法を指定します。通常、これらの空のリクエストは、ロードバランサーのヘルスプローブまたは Web ブラウザーの投機的接続 ("事前接続") から送信されます。この場合、これらのリクエストをログに記録することは望ましくない場合があります。ただし、これらのリクエストはネットワークエラーによっても発生する可能性があります。その場合、空のリクエストをログに記録すると、エラーの診断に役立つ場合があります。さらに、これらのリクエストはポートスキャンによって引き起こされる可能性があります。その場合、空のリクエストをログに記録すると、侵入の試みを検出するのに役立つ場合があります。このフィールドに使用できる値は "Log" および "Ignore" です。デフォルト値は "Log" です。 |
15.1.34. .spec.logging.access.destination リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 宛先はアクセスログの移動先です。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| コンテナーは、コンテナーのロギング先のパラメーターを保持します。タイプがコンテナーの場合にのみ存在します。 |
|
|
| syslog は、syslog エンドポイントのパラメーターを保持します。タイプが Syslog の場合にのみ存在します。 |
|
|
| type はログの宛先のタイプです。次のいずれかである必要があります。 * Container Ingress Operator が、Ingress コントローラー Pod に "logs" という名前のサイドカーコンテナーを設定し、サイドカーにログを書き込むように Ingress コントローラーを設定します。その後、ログはコンテナーログとして利用できます。管理者がこのコンテナーからログを読み取るカスタムロギングソリューションを設定することが予想されます。コンテナーログを使用するということは、ログの割合がコンテナーランタイムまたはカスタムログソリューションの容量を超えると、ログがドロップされる可能性があるということに注意してください。 * Syslog ログが syslog エンドポイントに送信されます。管理者は、Syslog メッセージを受信できるエンドポイントを指定する必要があります。管理者がカスタム Syslog インスタンスを設定していることが予想されます。 |
15.1.35. .spec.logging.access.destination.container リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- コンテナーは、コンテナーのロギング先のパラメーターを保持します。タイプがコンテナーの場合にのみ存在します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| maxLength は、ログメッセージの最大長です。 有効な値は 480 から 8192 までの範囲の整数です。 省略した場合のデフォルト値は 1024 です。 |
15.1.36. .spec.logging.access.destination.syslog リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- syslog は、syslog エンドポイントのパラメーターを保持します。タイプが Syslog の場合にのみ存在します。
- 型
-
object - 必須
-
address -
port
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| address は、ログメッセージを受信する syslog エンドポイントの IP アドレスです。 |
|
|
| facility はログメッセージの syslog ファシリティーを指定します。 このフィールドが空の場合、ファシリティーは "local1" になります。 |
|
|
| maxLength は、ログメッセージの最大長です。 有効な値は 480 から 4096 までの範囲の整数です。 省略した場合のデフォルト値は 1024 です。 |
|
|
| port は、ログメッセージを受信する syslog エンドポイントの UDP ポート番号です。 |
15.1.37. .spec.logging.access.httpCaptureHeaders リンクのコピーリンクがクリップボードにコピーされました!
- 説明
httpCaptureHeaders は、アクセスログにキャプチャする必要がある HTTP ヘッダーを定義します。このフィールドが空の場合、ヘッダーはキャプチャされません。
このオプションは、クリアテキスト HTTP 接続と、入力コントローラーが暗号化を終了するセキュア HTTP 接続 (つまり、エッジ終了または再暗号化接続) にのみ適用されることに注意してください。TLS パススルー接続のヘッダーをキャプチャすることはできません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | request は、キャプチャする HTTP リクエストヘッダーを指定します。 このフィールドが空の場合、リクエストヘッダーは調整されません。 |
|
| `` | response は、キャプチャする HTTP 応答ヘッダーを指定します。 このフィールドが空の場合、応答ヘッダーはキャプチャされません。 |
15.1.38. .spec.namespaceSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
namespaceSelector は、Ingress コントローラーによって提供される namespace セットをフィルターするために使用されます。これはシャードの実装に役立ちます。
設定されていない場合、デフォルトはフィルタリングなしです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
15.1.39. .spec.namespaceSelector.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
15.1.40. .spec.namespaceSelector.matchExpressions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
15.1.41. .spec.nodePlacement リンクのコピーリンクがクリップボードにコピーされました!
- 説明
nodePlacement は、Ingress コントローラーのスケジュールに対する明示的な制御を有効にします。
設定されていない場合、デフォルトが使用されます。詳細は、NodePlacement を参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| nodeSelector は、入力コントローラーのデプロイメントに適用されるノードセレクターです。 設定されている場合、指定されたセレクターが使用され、デフォルトが置き換えられます。 設定されていない場合、クラスターの config.openshift.io/v1/ingresses ステータスの defaultPlacement フィールドの値によってデフォルトが決まります。 defaultPlacement が Workers の場合、デフォルトは次のとおりです。 kubernetes.io/os: linux node-role.kubernetes.io/worker: '' defaultPlacement が ControlPlane の場合、デフォルトは次のとおりです。 kubernetes.io/os: linux node-role.kubernetes.io/master: '' これらのデフォルトは変更される可能性があります。 nodeSelector.matchExpressions の使用はサポートされていないことに注意してください。nodeSelector.matchLabels のみ使用できます。これは Kubernetes API の制限です。Pod 仕様では、ノードセレクターに複雑な式を使用することはできません。 |
|
|
| tolerations は、入力コントローラーのデプロイメントに適用される許容値のリストです。 デフォルトは空のリストです。 See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ |
|
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
15.1.42. .spec.nodePlacement.nodeSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
nodeSelector は、入力コントローラーのデプロイメントに適用されるノードセレクターです。
設定されている場合、指定されたセレクターが使用され、デフォルトが置き換えられます。
設定されていない場合、クラスターの config.openshift.io/v1/ingresses ステータスの defaultPlacement フィールドの値によってデフォルトが決まります。
defaultPlacement が Workers の場合、デフォルトは次のとおりです。
kubernetes.io/os: linux node-role.kubernetes.io/worker: ''
kubernetes.io/os: linux node-role.kubernetes.io/worker: ''Copy to Clipboard Copied! Toggle word wrap Toggle overflow defaultPlacement が ControlPlane の場合、デフォルトは次のとおりです。
kubernetes.io/os: linux node-role.kubernetes.io/master: ''
kubernetes.io/os: linux node-role.kubernetes.io/master: ''Copy to Clipboard Copied! Toggle word wrap Toggle overflow これらのデフォルトは変更される可能性があります。
nodeSelector.matchExpressions の使用はサポートされていないことに注意してください。nodeSelector.matchLabels のみ使用できます。これは Kubernetes API の制限です。Pod 仕様では、ノードセレクターに複雑な式を使用することはできません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
15.1.43. .spec.nodePlacement.nodeSelector.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
15.1.44. .spec.nodePlacement.nodeSelector.matchExpressions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
15.1.45. .spec.nodePlacement.tolerations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
tolerations は、入力コントローラーのデプロイメントに適用される許容値のリストです。
デフォルトは空のリストです。
See https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
- 型
-
array
15.1.46. .spec.nodePlacement.tolerations[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。 |
|
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。 |
|
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (退避しないでください)。ゼロ値と負の値は、システムによって 0 (すぐに退避) として扱われます。 |
|
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
15.1.47. .spec.routeAdmission リンクのコピーリンクがクリップボードにコピーされました!
- 説明
routeAdmission は、新しいルート要求を処理するためのポリシーを定義します (たとえば、namespace 全体で要求を許可または拒否します)。
空の場合、デフォルトが適用されます。デフォルトの詳細は、特定の routeAdmission フィールドを参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| namespaceOwnership は、複数の namespace でホスト名の要求を処理する方法を示します。 値は次のいずれかである必要があります。 - Strict: 別々の namespace 内のルートが同じホストを要求することを禁止します。 - InterNamespaceAllowed: ルートが複数の namespace で同じホスト名を持つ異なるパスを要求することを許可します。 空の場合、デフォルトは Strict です。 |
|
|
| wildcardPolicy は、入力コントローラーに対してワイルドカードポリシーを使用したルートを処理する方法を説明します。WildcardPolicy は、ルートのワイルドカードポリシーに基づいて、Ingress コントローラーによって公開されるルート [1] の使用を制御します。 [1] https://github.com/openshift/api/blob/master/route/v1/types.go 注記: WildcardsAllowed を WildcardsAllowed から WildcardsDisallowed に更新すると、サブドメインのワイルドカードポリシーを持つ許可されたルートが機能しなくなります。これらのルートは、ingress コントローラーによって再許可されるために、ワイルドカードポリシーなしに更新する必要があります。 WildcardPolicy は、WildcardsAllowed および WildcardsDisallowed の値をサポートします。 空の場合、デフォルトは "WildcardsDisallowed" です。 |
15.1.48. .spec.routeSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
routeSelector は、Ingress コントローラーによって提供される Routes のセットをフィルターするために使用されます。これはシャードの実装に役立ちます。
設定されていない場合、デフォルトはフィルタリングなしです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
15.1.49. .spec.routeSelector.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
15.1.50. .spec.routeSelector.matchExpressions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
15.1.51. .spec.tlsSecurityProfile リンクのコピーリンクがクリップボードにコピーされました!
- 説明
tlsSecurityProfile は、Ingress コントローラーの TLS 接続の設定を指定します。
設定されていない場合、デフォルトは apiservers.config.openshift.io/cluster リソースに基づいています。
Old、Intermediate、および Modern のプロファイルタイプを使用する場合、有効なプロファイル設定はリリース間で変更される可能性があります。たとえば、リリース X.Y.Z にデプロイされた Intermediate プロファイルを使用する仕様がある場合、リリース X.Y.Z+1 へのアップグレードにより、新規のプロファイル設定が Ingress コントローラーに適用され、ロールアウトが生じる可能性があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | custom は、ユーザー定義の TLS セキュリティープロファイルです。無効な設定は壊滅的である可能性があるため、カスタムプロファイルの使用には細心の注意を払ってください。カスタムプロファイルの例は次のようになります。 暗号化: - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion: VersionTLS11 |
|
| `` | intermediate は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 以下のようになります (yaml): 暗号化: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 minTLSVersion: VersionTLS12 |
|
| `` | modern は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility 以下のようになります (yaml): 暗号化: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: VersionTLS13 |
|
| `` | old は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility 以下のようになります (yaml): 暗号化: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDHE-ECDSA-AES128-GCM-SHA256 - ECDHE-RSA-AES128-GCM-SHA256 - ECDHE-ECDSA-AES256-GCM-SHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 - DHE-RSA-CHACHA20-POLY1305 - ECDHE-ECDSA-AES128-SHA256 - ECDHE-RSA-AES128-SHA256 - ECDHE-ECDSA-AES128-SHA - ECDHE-RSA-AES128-SHA - ECDHE-ECDSA-AES256-SHA384 - ECDHE-RSA-AES256-SHA384 - ECDHE-ECDSA-AES256-SHA - ECDHE-RSA-AES256-SHA - DHE-RSA-AES128-SHA256 - DHE-RSA-AES256-SHA256 - AES128-GCM-SHA256 - AES256-GCM-SHA384 - AES128-SHA256 - AES256-SHA256 - AES128-SHA - AES256-SHA - DES-CBC3-SHA minTLSVersion: VersionTLS10 |
|
|
| type は、Old、Intermediate、Modern、または Custom のいずれかです。カスタムは、個々の TLS セキュリティープロファイルパラメーターを指定する機能を提供します。Old、Intermediate、Modern は、以下に基づく TLS セキュリティープロファイルです。 https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations プロファイルは意図に基づいているため、時間の経過とともに新しい暗号が開発され、既存の暗号がセキュアでないことが判明すると、変更される可能性があります。プロセスで使用できる暗号の正確さに応じて、リストが削減される場合があります。 Modern プロファイルは、一般的なソフトウェアライブラリーでまだ十分に採用されていないため、現在サポートされていないことに注意してください。 |
15.1.52. .spec.tuningOptions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
tuningOptions は、入力コントローラー Pod のパフォーマンスを調整するためのパラメーターを定義します。すべてのフィールドはオプションであり、設定されていない場合はそれぞれのデフォルトを使用します。詳細は、特定の tuningOptions フィールドを参照してください。
通常、tuningOptions 内でフィールドを設定することは推奨しません。デフォルト値は、ほとんどの設定に適しています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| clientFinTimeout は、サーバー/バックエンドが接続を閉じることに対するクライアントの応答を待機している間、接続が開いたままになる時間を定義します。 未設定の場合、デフォルトのタイムアウトは 1s です。 |
|
|
| clientTimeout は、クライアントの応答を待機している間、接続が開いたままになる時間を定義します。 未設定の場合、デフォルトのタイムアウトは 30s です。 |
|
|
| connectTimeout は、サーバー/バックエンドへの接続試行が成功するまで待機する最大時間を定義します。 このフィールドには、符号なしの 10 進数の期間文字列を指定する必要があります。それぞれの数字に少数 (任意) と単位の接尾辞を付けます。たとえば、"300ms"、"1.5h"、"2h45m" です。有効な時間単位は、"ns"、"us" (または "µs" U+00B5 か "μs" U+03BC)、"ms"、"s"、"m"、"h" です。 省略すると、ユーザーによる指定なしとみなされ、プラットフォームによって適切なデフォルトが選択されます。このデフォルトは、今後変更される可能性があります。現在のデフォルトは 5s です。 |
|
|
| headerBufferBytes は、IngressController 接続セッション用に予約する必要のあるメモリーの量 (バイト単位) を示します。IngressController (https://tools.ietf.org/html/rfc7540) で HTTP/2 が有効になっている場合、この値は少なくとも 16384 である必要があることに注意してください。このフィールドが空の場合、IngressController はデフォルト値の 32768 バイトを使用します。 小さすぎる headerBufferBytes 値は IngressController を壊す可能性があり、大きすぎる headerBufferBytes 値は、IngressController が必要以上に多くのメモリーを使用する可能性があるため、このフィールドの設定は一般に推奨されません。 |
|
|
| headerBufferMaxRewriteBytes は、IngressController の接続セッションにおいて、HTTP ヘッダの書き換えと追加のために headerBufferBytes から確保すべきメモリー量 (バイト数) を記述します。着信 HTTP リクエストは (headerBufferBytes --headerBufferMaxRewriteBytes) バイトに制限されることに注意してください。つまり、headerBufferBytes は headerBufferMaxRewriteBytes より大きくなければなりません。このフィールドが空の場合、IngressController はデフォルト値の 8192 バイトを使用します。 小さすぎる headerBufferMaxRewriteBytes 値は IngressController を壊す可能性があり、大きすぎる headerBufferMaxRewriteBytes 値は、IngressController が必要以上に大量のメモリーを使用する可能性があるため、このフィールドの設定は一般に推奨されません。 |
|
|
| healthCheckInterval は、ルーターに設定されたバックエンドに対する次回のヘルスチェックまでの間にルーターがどれだけの時間待機するかを定義します。この値は、すべてのルートのデフォルトとしてグローバルに適用されますが、ルートアノテーション "router.openshift.io/haproxy.health.check.interval" によってルートごとにオーバーライドされる場合があります。 符号なしの 10 進数の期間文字列を指定する必要があります。それぞれの数字に少数 (任意) と単位の接尾辞を付けます。たとえば、"300ms"、"1.5h"、"2h45m" です。有効な時間単位は、"ns"、"us" (または "µs" U+00B5 か "μs" U+03BC)、"ms"、"s"、"m"、"h" です。 これを 5 秒未満に設定すると、TCP ヘルスチェックが頻繁に行われ、SYN パケットストームが発生するため、過剰なトラフィックが発生する可能性があります。一方、この値を高く設定しすぎると、バックエンドサーバーが利用できないにもかかわらず、そのことがまだ検出されていないために、レイテンシーが増加する可能性があります。 healthCheckInterval が空またはゼロの場合、指定なしとみなされ、IngressController によってデフォルトが選択されます。デフォルトは、今後変更される可能性があります。現在、デフォルトの healthCheckInterval 値は 5s です。 現在、許容最小値は 1s、許容最大値は 2147483647ms (24.85 日) です。どちらも今後変更される可能性があります。 |
|
|
| maxConnections は、HAProxy プロセスごとに確立できる同時接続の最大数を定義します。この値を増やすと、各 Ingress Controller Pod がより多くの接続を処理できるようになりますが、消費されるシステムリソースが増えます。 許可される値は、空、0、-1、および 2000 - 2000000 の範囲です。 このフィールドが空または 0 の場合、IngressController はデフォルト値の 50000 を使用します。ただし、デフォルトは今後のリリースで変更される可能性があります。 値が -1 の場合、実行中のコンテナーで使用可能な ulimits に基づいて、HAProxy が最大値を動的に計算します。-1 (自動) を選択すると、大きな値 (OpenShift 4.10 以上のクラスターでは約 520000) が計算されます。そのため、各 HAProxy プロセスで、現在のデフォルトの 50000 と比較して大量のメモリーが使用されます。 現在のオペレーティングシステムの制限より大きい値を設定すると、HAProxy プロセスが起動しなくなります。 個別の値 (例: 750000) を選択しても、ルーター Pod が新しいノードに移行されたときに、その新しいノードに同じ ulimits が設定されているとは限りません。このような場合、Pod は起動に失敗します。異なる ulimits が設定されたノード (異なる tuned プロファイルなど) があり、個別の値を選択する場合は、-1 を使用して、実行時に値を動的に計算するようにすることを推奨します。 メトリクス 'container_memory_working_set_bytes{container="router",namespace="openshift-ingress"}' を使用すると、ルーターコンテナーのメモリー使用量を監視できます。 メトリクス 'container_memory_working_set_bytes{container="router",namespace="openshift-ingress"}/container_processes{container="router",namespace="openshift-ingress"}' を使用すると、ルーターコンテナー内の個々の HAProxy プロセスのメモリー使用量を監視できます。 |
|
|
| reloadInterval は、新しい変更を適用するために、ルーターに許可するリロードの最小間隔を定義します。この値を増やすと、状況に応じて HAProxy プロセスの蓄積を防ぐことができます。この間隔を長くすると、ラウンドロビン分散アルゴリズムを使用するときに、バックエンドのサーバーの負荷の不均衡を軽減することもできます。または、この値を減らすと、HAProxy の設定の更新がより早く有効になるため、レイテンシーが短縮される可能性があります。 値は時間間隔の値である必要があります。https://pkg.go.dev/time#ParseDuration を参照してください。現在、許容最小値は 1s、許容最大値は 120s です。許容最小値と許容最大値は、OpenShift の今後のバージョンで変更される可能性があります。この範囲外の期間を指定しても、reloadInterval の値は制限され、拒否されないことに注意してください (たとえば、120 秒を超える期間は 120 秒に制限されます。IngressController はその使用できない値を拒否せず、デフォルト値に置き換えます)。 reloadInterval の値が 0 の場合、IngressController はデフォルトを選択します。デフォルトは現在 5s ですが、予告なく変更される可能性があります。 このフィールドには、符号なしの 10 進数の期間文字列を指定する必要があります。それぞれの数字に少数 (任意) と単位の接尾辞を付けます。たとえば、"300ms"、"1.5h"、"2h45m" です。有効な時間単位は、"ns"、"us" (または "µs" U+00B5 か "μs" U+03BC)、"ms"、"s"、"m"、"h" です。 注記: デフォルトの 5 秒よりも大幅に大きい値を設定すると、ルートとそのエンドポイントへの更新の監視にレイテンシーが発生する可能性があります。HAProxy の設定のリロード頻度が下がり、新しく作成されたルートが次回のリロードまで提供されなくなります。 |
|
|
| serverFinTimeout は、接続を閉じるクライアントへのサーバー/バックエンドの応答を待機している間、接続が開いたままになる時間を定義します。 未設定の場合、デフォルトのタイムアウトは 1s です。 |
|
|
| serverTimeout は、サーバー/バックエンドの応答を待機している間、接続が開いたままになる時間を定義します。 未設定の場合、デフォルトのタイムアウトは 30s です。 |
|
|
| threadCount は、HAProxy プロセスごとに作成されるスレッドの数を定義します。より多くのスレッドを作成すると、使用されるシステムリソースを増やすことで、各 Ingress コントローラー Pod がより多くの接続を処理できるようになります。HAProxy は現在、最大 64 のスレッドをサポートしています。このフィールドが空の場合、IngressController はデフォルト値を使用します。現在のデフォルトは 4 スレッドですが、これは将来のリリースで変更される可能性があります。 通常、このフィールドを設定することは推奨しません。HAProxy スレッドの数を増やすと、入力コントローラー Pod は負荷がかかった状態でより多くの CPU 時間を利用できるようになり、設定が高すぎると他の Pod が不足する可能性があります。スレッドの数を減らすと、Ingress コントローラーのパフォーマンスが低下する可能性があります。 |
|
|
| tlsInspectDelay は、一致するルートを見つけるためにルーターがデータを保持できる期間を定義します。 これを短く設定しすぎると、より一致する証明書を使用できる場合でも、ルーターがエッジ終端または再暗号化ルートのデフォルト証明書にフォールバックする可能性があります。 未設定の場合、デフォルトの検査遅延は 5s です。 |
|
|
| tunnelTimeout は、トンネルがアイドル状態のときにトンネル接続 (WebSocket を含む) が開いたままになる時間を定義します。 未設定の場合、デフォルトのタイムアウトは 1h です。 |
15.1.53. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、IngressController の最後に観察されたステータスです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| availableReplicas は、入力コントローラーのデプロイメントに応じて監視された使用可能なレプリカの数です。 |
|
|
| conditions は、状態とそのステータスのリストです。 Available は、Ingress コントローラーのデプロイメントが利用可能であり、ルートおよび Ingress リソースを処理していることを意味します (つまり、.status.availableReplicas は .spec.replicas と同等)。 これ以外にも、Ingress コントローラーの他の機能とケイパビリティーのステータスを示す状態があります。 * LoadBalancerManaged - 次の条件が満たされている場合は True です。* エンドポイント公開ストラテジーにサービスロードバランサーが必要である。- これらの条件のいずれかが満たされていない場合は False です。 * LoadBalancerReady - 次の条件が満たされている場合は True です。* ロードバランサーが管理対象である。* ロードバランサーの準備ができている。- これらの条件のいずれかが満たされていない場合は False です。 * DNSManaged - 次の条件が満たされている場合は True です。* エンドポイント公開ストラテジーとプラットフォームが DNS をサポートしている。* Ingress コントローラードメインが設定されている。* dns.config.openshift.io/cluster で DNS ゾーンが設定されている。- これらの条件のいずれかが満たされていない場合は False です。 * DNSReady - 次の条件が満たされている場合は True です。* DNS が管理対象である。* DNS レコードが正常に作成された。- これらの条件のいずれかが満たされていない場合は False です。 |
|
|
| OperatorCondition は、標準の状態フィールドです。 |
|
|
| domain は、実際に使用されているドメインです。 |
|
|
| endpointPublishingStrategy は、実際に使用されている戦略です。 |
|
|
| namespaceSelector は、実際に使用されている namespaceSelector です。 |
|
|
| observedGeneration は、観察された最新の世代です。 |
|
|
| routeSelector は、実際に使用されている routeSelector です。 |
|
|
| セレクターは、IngressController に対応するイングレスコントローラー Pod 用の文字列形式のラベルセレクターです。一致する Pod の数は、availableReplicas の値と同じである必要があります。 |
|
|
| tlsProfile は、有効な TLS 接続設定です。 |
15.1.54. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
conditions は、状態とそのステータスのリストです。
Available は、Ingress コントローラーのデプロイメントが利用可能であり、ルートおよび Ingress リソースを処理していることを意味します (つまり、.status.availableReplicas は .spec.replicas と同等)。
これ以外にも、Ingress コントローラーの他の機能とケイパビリティーのステータスを示す状態があります。
LoadBalancerManaged
- 次の条件が満たされている場合は True です。
エンドポイント公開ストラテジーにサービスロードバランサーが必要である。
- いずれかの条件が満たされていない場合は False です。
LoadBalancerReady
- 次の条件が満たされている場合は True です。
- ロードバランサーが管理対象である。
ロードバランサーの準備ができている。
- いずれかの条件が満たされていない場合は False です。
DNSManaged
- 次の条件が満たされている場合は True です。
- エンドポイント公開ストラテジーとプラットフォームが DNS をサポートしている。
- Ingress コントローラードメインが設定されている。
dns.config.openshift.io/cluster で DNS ゾーンが設定されている。
- いずれかの条件が満たされていない場合は False です。
DNSReady
- 次の条件が満たされている場合は True です。
- DNS が管理対象である。
DNS レコードが正常に作成された。
- いずれかの条件が満たされていない場合は False です。
- 型
-
array
15.1.55. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorCondition は、標準の状態フィールドです。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| |
|
|
| |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
15.1.56. .status.endpointPublishingStrategy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- endpointPublishingStrategy は、実際に使用されている戦略です。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| hostNetwork は、HostNetwork エンドポイント公開戦略のパラメーターを保持します。タイプが HostNetwork の場合にのみ存在します。 |
|
|
| loadBalancer は、ロードバランサーのパラメーターを保持します。タイプが LoadBalancerService の場合にのみ存在します。 |
|
|
| nodePort は、NodePortService エンドポイント公開戦略のパラメーターを保持します。タイプが NodePortService の場合にのみ存在します。 |
|
|
| private は、プライベートエンドポイント公開戦略のパラメーターを保持します。タイプがプライベートの場合にのみ存在します。 |
|
|
| type は、使用する公開戦略です。有効な値は以下のとおりです。 * LoadBalancerService Kubernetes LoadBalancer サービスを使用して Ingress コントローラーを公開します。 この設定では、Ingress コントローラーのデプロイメントはコンテナーのネットワークを使用します。LoadBalancer サービスは、デプロイメントを公開するために作成されます。 参照: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer ドメインが設定されている場合、ワイルドカード DNS レコードは LoadBalancer サービスの外部名を参照するように管理されます。DNS レコードは、dns.config.openshift.io/cluster.spec.publicZone および.spec.privateZone で定義された DNS ゾーンでのみ管理されます。 ワイルドカード DNS 管理は現在、AWS、Azure、および GCP プラットフォームでのみサポートされています。 * HostNetwork Ingress コントローラーがデプロイされているノードポートに Ingress コントローラーを公開します。 この設定では、Ingress コントローラーのデプロイメントはノードポート 80 および 443 にバインドされたホストネットワークを使用します。ユーザーは、ノードポート経由で Ingress コントローラーを公開するための外部ロードバランサーを設定する必要があります。 * Private Ingress コントローラーを公開しません。 この設定では、Ingress コントローラーのデプロイメントはコンテナーネットワークを使用し、明示的に公開されません。ユーザーは Ingress コントローラーを手動で公開する必要があります。 * NodePortService Kubernetes NodePort サービスを使用して Ingress コントローラーを公開します。 この設定では、Ingress コントローラーのデプロイメントはコンテナーのネットワークを使用します。デプロイメントを公開するために NodePort Service が作成されます。特定のノードポートは、OpenShift によって動的に割り当てられます。ただし、静的ポート割り当てをサポートするために、マネージド NodePort サービスのノードポートフィールドへのユーザーの変更は保持されます。 |