設定 API
設定 API のリファレンスガイド
概要
第1章 設定 API リンクのコピーリンクがクリップボードにコピーされました!
1.1. APIServer [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- APIServer は、システム内のすべての API サーバー、特に kube-apiserver と openshift-apiserver によって共有される設定 (サービング証明書、クライアント CA、CORS ドメインなど) を保持します。インスタンスの正規名は 'cluster' です。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.2. Authentication [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
認証は、認証のクラスター全体の設定を指定します (OAuth や Webhook トークンオーセンティケーターなど)。インスタンスの正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.3. Build [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ビルドは、クラスター全体の OpenShift ビルドの動作を設定します。これには、BuildConfig オブジェクトでオーバーライドできるデフォルト設定と、すべてのビルドに適用されるオーバーライドが含まれます。正規名は "cluster" です。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.4. ClusterOperator [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterOperator は、Operator の現在の状態を保持するカスタムリソースオブジェクトです。このオブジェクトは、Operator によってそれらの状態をクラスターの残りの部分に送るために使用されます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.5. ClusterVersion [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterVersion は、ClusterVersionOperator の設定です。ここで、自動更新に関連するパラメーターを設定できます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.6. Console [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
コンソールは、ログアウト URL を含む Web コンソールのクラスター全体の設定を保持し、コンソールのパブリック URL を報告します。正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.7. DNS [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
DNS は、DNS に関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.8. FeatureGate [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
機能は、機能ゲートに関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.9. HelmChartRepository [helm.openshift.io/v1beta1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- HelmChartRepository は、プロキシーされた Helm チャートリポジトリーのクラスター全体の設定を保持します。互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (いずれか長い方) の間安定しています。
- 型
-
object
1.10. Image [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- イメージは、イメージストリームのインポートと外部レジストリーのランタイム設定に関連するポリシーを管理します。これにより、クラスター管理者は、OpenShift がイメージのインポートを許可されるレジストリー、外部レジストリー用の追加の CA トラストバンドル、およびレジストリーのホスト名をブロックまたは許可するポリシーを設定できます。OpenShift のイメージレジストリーを公開する場合、これによりクラスター管理者は外部ホスト名を指定することもできます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.11. ImageContentPolicy [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageContentPolicy は、レジストリーミラールールの処理方法に関するクラスター全体の情報を保持します。複数のポリシーが定義されている場合、動作の結果は各フィールドで定義されます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.12. Infrastructure [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
インフラストラクチャーは、インフラストラクチャーに関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.13. Ingress [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
Ingress は、ルートに使用されるデフォルトの入力ドメインを含む、入力に関するクラスター全体の情報を保持します。正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.14. Network [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
ネットワークは、ネットワークに関するクラスター全体の情報を保持します。正規名は
clusterです。これは、サービス/Pod IP の IP アドレスプール、ネットワークプラグインなどの目的のネットワーク設定を設定するために使用されます。このリソースを設定するときに適用される内容の説明は、network.spec を参照してください。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.15. Node [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Node は、ノード固有の機能に関するクラスター全体の情報を保持します。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.16. OAuth [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
OAuth は、OAuth に関するクラスター全体の情報を保持します。正規名は
clusterです。統合された OAuth サーバーを設定するために使用されます。この設定は、最上位の認証設定のタイプが IntegratedOAuth に設定されている場合にのみ適用されます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.17. OperatorHub [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorHub は、operatorhubs API のスキーマです。これを使用して、クラスター上の OperatorHub のデフォルトハブソースの状態を有効から無効に、またはその逆に変更できます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
1.18. Project [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
Project は、Project に関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.19. ProjectHelmChartRepository [helm.openshift.io/v1beta1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ProjectHelmChartRepository は、プロキシーされた Helm チャートリポジトリーの namespace 全体の設定を保持します。互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリースのうち、いずれか長い方の期間で安定しています。
- 型
-
object
1.20. Proxy [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
プロキシーは、クラスターのデフォルトプロキシーを設定する方法に関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.21. Scheduler [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
スケジューラーは、クラスター全体の設定情報を保持して、Kubernetes スケジューラーを実行し、その配置の決定に影響を与えます。この設定の正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
第2章 APIServer [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- APIServer は、システム内のすべての API サーバー、特に kube-apiserver と openshift-apiserver によって共有される設定 (サービング証明書、クライアント CA、CORS ドメインなど) を保持します。インスタンスの正規名は 'cluster' です。互換性レベル 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 を参照してください。 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
2.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| additionalCORSAllowedOrigins は、API サーバーが CORS ヘッダーを使用してアクセスを許可するホストを記述する追加のユーザー定義の正規表現をリスト表示します。これは、JavaScript アプリケーションから API および統合 OAuth サーバーにアクセスするために必要になる場合があります。値は、Golang 正規表現言語に対応する正規表現です。 |
|
|
| audit は、クラスター内のすべての OpenShift 提供の API サーバーに適用される監査設定の設定を指定します。 |
|
|
| clientCA は、Operator が管理する署名者に加えて、着信クライアント証明書で認識される署名者の証明書バンドルを含む ConfigMap を参照します。これが空の場合、Operator が管理する署名者のみが有効です。通常、これを設定する必要があるのは、クライアント証明書を尊重したい独自の PKI がある場合のみです。ConfigMap は、openshift-config 名前空間に存在し、以下の必須フィールドを含む必要があります。- ConfigMap.Data["ca-bundle.crt"] - CA バンドル。 |
|
|
| 暗号化により、データストア層でのリソースの暗号化を設定できます。 |
|
|
| servingCert は、安全なトラフィックを提供するための TLS 証明書情報です。指定しない場合、Operator が管理する証明書は、安全なトラフィックを提供するために使用されます。 |
|
|
| tlsSecurityProfile は、外部に公開されたサーバーの TLS 接続の設定を指定します。設定されていない場合、デフォルト (リリース間で変更される可能性があります) が選択されます。現在サポートされているのは Old、Intermediate、および Custom プロファイルのみであり、使用可能な MinTLSVersions の最大数は VersionTLS12 であることに注意してください。 |
2.1.2. .spec.audit リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- audit は、クラスター内のすべての OpenShift 提供の API サーバーに適用される監査設定の設定を指定します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| customRules は、グループごとのプロファイルを指定します。これらのプロファイルは、該当する場合、最上位のプロファイルフィールドよりも優先されます。それらは上から下への評価であり、最初に一致するものが適用されます。 |
|
|
| AuditCustomRule は、最上位プロファイルよりも優先される監査プロファイルのカスタムルールを記述します。 |
|
|
|
profile は、クラスター内の OpenShift が提供する API サーバー (kube-apiserver、openshift-apiserver、oauth-apiserver) のいずれかに送信されるすべてのリクエストに適用される、目的のトップレベル監査プロファイルの名前を指定します。1 つ以上の customRules に一致するリクエスト。次のプロファイルが提供されます。- デフォルト: デフォルトのポリシー。これは、イベント (まったくログに記録されない)、oauthaccesstokens、および oauthauthorizetokens (両方とも RequestBody レベルでログに記録される) を除く MetaData レベルのログを意味します。- WriteRequestBodies: 'デフォルト' と同様ですが、書き込みリクエスト (作成、更新、パッチ) のリクエストとレスポンスの HTTP ペイロードをログに記録します。- AllRequestBodies: 'WriteRequestBodies' と同様ですが、読み取りリクエスト (get、list) のリクエストおよびレスポンス HTTP ペイロードもログに記録します。- None: oauthaccesstokens や oauthauthorizetokens も含め、リクエストはいっさいログに記録されません。警告: 問題のトラブルシューティング時に有用なデータが記録されないリスクを完全に理解していない限り、 |
2.1.3. .spec.audit.customRules リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- customRules は、グループごとのプロファイルを指定します。これらのプロファイルは、該当する場合、最上位のプロファイルフィールドよりも優先されます。それらは上から下への評価であり、最初に一致するものが適用されます。
- 型
-
array
2.1.4. .spec.audit.customRules[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AuditCustomRule は、最上位プロファイルよりも優先される監査プロファイルのカスタムルールを記述します。
- 型
-
object - 必須
-
group -
profile
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は、このプロファイルを適用するためにリクエストユーザーがメンバーである必要があるグループの名前です。 |
|
|
| プロファイルは、クラスター内のすべての OpenShift 提供の API サーバーにデプロイする必要のある監査ポリシー設定の名前を指定します。次のプロファイルが提供されています。- デフォルト: 既存のデフォルトポリシー。- WriteRequestBodies: 'デフォルト' と同様ですが、書き込みリクエスト (作成、更新、パッチ) のリクエストとレスポンスの HTTP ペイロードをログに記録します。- AllRequestBodies: 'WriteRequestBodies' と同様ですが、読み取りリクエスト (get、list) のリクエストとレスポンス HTTP ペイロードもログに記録します。- None: oauthaccesstokens や oauthauthorizetokens を含め、リクエストはまったくログに記録されません。設定されていない場合、'Default' プロファイルがデフォルトとして使用されます。 |
2.1.5. .spec.clientCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientCA は、Operator が管理する署名者に加えて、着信クライアント証明書で認識される署名者の証明書バンドルを含む ConfigMap を参照します。これが空の場合、Operator が管理する署名者のみが有効です。通常、これを設定する必要があるのは、クライアント証明書を尊重したい独自の PKI がある場合のみです。ConfigMap は、openshift-config 名前空間に存在し、以下の必須フィールドを含む必要があります。- ConfigMap.Data["ca-bundle.crt"] - CA バンドル。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
2.1.6. .spec.encryption リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 暗号化により、データストア層でのリソースの暗号化を設定できます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| type は、データストア層でリソースを暗号化するために使用する暗号化タイプを定義します。このフィールドが設定されていない場合 (つまり、空の文字列に設定されている場合)、ID が暗黙指定されます。unset の動作は、時間の経過とともに変化する可能性があります。暗号化がデフォルトで有効になっている場合でも、ベストプラクティスの変更に基づいて、未設定の意味が別の暗号化タイプに変更される場合があります。暗号化を有効にすると、プラットフォームに付属するすべての機密リソースが暗号化されます。この機密リソースのリストは、時間の経過とともに変化する可能性があります。現在の権限のあるリストは次のとおりです。1。シークレット 2.configmaps3.routes.route.openshift.io 4. oauthaccesstokens.oauth.openshift.io 5. oauthauthorizetokens.oauth.openshift.io |
2.1.7. .spec.servingCerts リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- servingCert は、安全なトラフィックを提供するための TLS 証明書情報です。指定しない場合、Operator が管理する証明書は、安全なトラフィックを提供するために使用されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| namedCertificates は、特定のホスト名に安全なトラフィックを提供するための TLS 証明書情報を含むシークレットを参照します。名前付き証明書が提供されていない場合、またはクライアントが理解できるようにサーバー名と一致する名前付き証明書がない場合は、defaultServingCertificate が使用されます。 |
|
|
| APIServerNamedServingCert は、クライアントが理解できるように、サーバーの DNS 名を証明書にマップします。 |
2.1.8. .spec.servingCerts.namedCertificates リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- namedCertificates は、特定のホスト名に安全なトラフィックを提供するための TLS 証明書情報を含むシークレットを参照します。名前付き証明書が提供されていない場合、またはクライアントが理解できるようにサーバー名と一致する名前付き証明書がない場合は、defaultServingCertificate が使用されます。
- 型
-
array
2.1.9. .spec.servingCerts.namedCertificates[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- APIServerNamedServingCert は、クライアントが理解できるように、サーバーの DNS 名を証明書にマップします。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| names は、安全なトラフィックを提供するためにこの証明書を使用する必要がある明示的な DNS 名 (先頭のワイルドカードを許可) のオプションのリストです。名前が指定されていない場合、暗黙の名前が証明書から抽出されます。正確な名前はワイルドカード名よりも優先されます。ここで定義された明示的な名前は、抽出された暗黙的な名前よりも優先されます。 |
|
|
| servingCertificate は、安全なトラフィックを提供するための TLS 証明書情報を含む kubernetes.io/tls タイプシークレットを参照します。シークレットは openshift-config 名前空間に存在し、以下の必須フィールドを含む必要があります。- Secret.Data["tls.key"] - TLS private key - Secret.Data["tls.crt"] - TLS certificate |
2.1.10. .spec.servingCerts.namedCertificates[].servingCertificate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- servingCertificate は、安全なトラフィックを提供するための TLS 証明書情報を含む kubernetes.io/tls タイプシークレットを参照します。シークレットは openshift-config 名前空間に存在し、以下の必須フィールドを含む必要があります。- Secret.Data["tls.key"] - TLS private key - Secret.Data["tls.crt"] - TLS certificate
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
2.1.11. .spec.tlsSecurityProfile リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tlsSecurityProfile は、外部に公開されたサーバーの TLS 接続の設定を指定します。設定されていない場合、デフォルト (リリース間で変更される可能性があります) が選択されます。現在サポートされているのは Old、Intermediate、および Custom プロファイルのみであり、使用可能な MinTLSVersions の最大数は VersionTLS12 であることに注意してください。
- タイプ
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | custom は、ユーザー定義の TLS セキュリティープロファイルです。無効な設定は壊滅的である可能性があるため、カスタムプロファイルの使用には細心の注意を払ってください。カスタムプロファイルの例は次のようになります。暗号:-ECDHE-ECDSA-CHACHA20-POLY1305-ECDHE-RSA-CHACHA20-POLY1305-ECDHE-RSA-AES128-GCM-SHA256-ECDHE-ECDSA-AES128-GCM-SHA256 minTLSVersion:TLSv1。1 |
|
| `` | intermediate は、https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28recommended.29 に基づく TLS セキュリティープロファイルです。以下のようなものです (yaml): 暗号: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - ECDH-ECDSA-AES128-GCM-SHA256 - ECDH-ECRSA-AES128-GCM-SHA256 - ECDH-ECDSA-AES256-GCM- - ECDH-ECDSA-AES128- GCASHA384 - ECDHE-RSA-AES256-GCM-SHA384 - ECDHE-ECDSA-CHACHA20-POLY1305 - ECDHE-RSA-CHACHA20-POLY1305 - DHE-RSA-AES128-GCM-SHA256 - DHE-RSA-AES256-GCM-SHA384 minTLSVersion:TLSv1.2 |
|
| `` | modern は、https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility に基づく TLS セキュリティープロファイルであり、次のようになります (yaml): 暗号: - TLS_AES_128_GCM_SHA256 - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 minTLSVersion: TLSv1.3 注記: 現在サポートされていません。 |
|
| `` | 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: TLSv1.0 |
|
|
| type は、Old、Intermediate、Modern、または Custom のいずれかです。カスタムは、個々の TLS セキュリティープロファイルパラメーターを指定する機能を提供します。Old、Intermediate、Modern は、以下に基づく TLS セキュリティープロファイルです https://wiki.mozilla.org/Security/Server_Side_TLS#Recommended_configurations プロファイルはインテントベースであるため、新しい暗号が開発され、既存の暗号が安全ではありません。プロセスで使用できる暗号の正確さに応じて、リストが削減される場合があります。Modern プロファイルは、一般的なソフトウェアライブラリーでまだ十分に採用されていないため、現在サポートされていないことに注意してください。 |
2.1.12. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
2.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/apiservers-
DELETE:APIServer のコレクションを削除します -
GET: 種類 APIServer のオブジェクトをリスト表示します -
POST:APIServer を作成します
-
/apis/config.openshift.io/v1/apiservers/{name}-
削除:APIServer を削除します -
GET: 指定された APIServer を読み取ります -
PATCH: 指定された APIServer を部分的に更新します -
PUT: 指定された APIServer を置き換えます
-
/apis/config.openshift.io/v1/apiservers/{name}/status-
GET: 指定された APIServer のステータスを読み取ります -
PATCH: 指定された APIServer のステータスを部分的に更新します -
PUT: 指定された APIServer のステータスを置き換えます
-
2.2.1. /apis/config.openshift.io/v1/apiservers リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- APIServer のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- APIServer の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- APIServer を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
2.2.2. /apis/config.openshift.io/v1/apiservers/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| APIServer の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- APIServer を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された APIServer を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された APIServer を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された APIServer を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
2.2.3. /apis/config.openshift.io/v1/apiservers/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| APIServer の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された APIServer のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された APIServer のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された APIServer のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第3章 Authentication [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
認証は、認証のクラスター全体の設定を指定します (OAuth や Webhook トークンオーセンティケーターなど)。インスタンスの正規名は
clusterです。互換性レベル 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 を参照してください。 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
3.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| oauthMetadata には、外部 OAuth サーバーの OAuth 2.0 認証サーバーメタデータの検出エンドポイントデータが含まれています。この検出ドキュメントは、提供された場所から参照することができます: oc get --raw '/.well-known/oauth-authorization-server'。詳細は、IETF ドラフトを参照してください。https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 oauthMetadata.name が空でない場合、この値は status に格納されているどのメタデータ参照よりも優先されます。キー "oauthMetadata" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、メタデータは提供されません。指定されたメタデータが有効でない場合、メタデータは提供されません。この設定マップの namespace は openshift-config です。 |
|
|
| serviceAccountIssuer は、バインドされたサービスアカウントトークン発行者の識別子です。デフォルトは https://kubernetes.default.svc です。警告: このフィールドを更新しても、以前の発行者値を持つ、バインドされたすべてのトークンがすぐに無効になるわけではありません。代わりに、以前のサービスアカウント発行者が発行したトークンが、プラットフォームによって選択された期間 (現在は 24h に設定) にわたり引き続き信頼されます。この期間は、時間の経過とともに変更される可能性があります。これにより、内部コンポーネントはサービスを中断することなく、新しいサービスアカウント発行者を使用するように移行できます。 |
|
|
| type は、使用中のクラスター管理のユーザー向け認証モードを識別します。具体的には、ログイン試行に応答するコンポーネントを管理します。デフォルトは IntegratedOAuth です。 |
|
|
| webhookTokenAuthenticator は、リモートトークンレビューアーを設定します。これらのリモート認証 Webhook は、tokenreviews.authentication.k8s.io REST API. API を介してベアラトークンを検証するために使用できます。これは、外部認証サービスによってプロビジョニングされたベアラトークンを尊重するために必要です。 |
|
|
| webhookTokenAuthenticators は非推奨であり、設定しても効果はありません。 |
|
|
| deprecatedWebhookTokenAuthenticator は、リモートトークンオーセンティケーターに必要な設定オプションを保持します。WebhookTokenAuthenticator と同じですが、KubeConfig フィールドの 'required' 検証がありません。 |
3.1.2. .spec.oauthMetadata リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- oauthMetadata には、外部 OAuth サーバーの OAuth 2.0 認証サーバーメタデータの検出エンドポイントデータが含まれています。この検出ドキュメントは、提供された場所から参照することができます: oc get --raw '/.well-known/oauth-authorization-server'。詳細は、IETF ドラフトを参照してください。https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2 oauthMetadata.name が空でない場合、この値は status に格納されているどのメタデータ参照よりも優先されます。キー "oauthMetadata" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、メタデータは提供されません。指定されたメタデータが有効でない場合、メタデータは提供されません。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
3.1.3. .spec.webhookTokenAuthenticator リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- webhookTokenAuthenticator は、リモートトークンレビューアーを設定します。これらのリモート認証 Webhook は、tokenreviews.authentication.k8s.io REST API. API を介してベアラトークンを検証するために使用できます。これは、外部認証サービスによってプロビジョニングされたベアラトークンを尊重するために必要です。
- タイプ
-
object - 必須
-
kubeConfig
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| kubeConfig は、リモート Webhook サービスにアクセスする方法を説明する kube 設定ファイルデータを含むシークレットを参照します。参照されるシークレットのネームスペースは openshift-config です。詳細は、https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication を参照してください。キー "kubeConfig" を使用してデータを検索します。シークレットキーまたは期待されるキーが見つからない場合、Webhook は受け入れられません。指定された kube 設定データが無効な場合、Webhook は受け入れられません。 |
3.1.4. .spec.webhookTokenAuthenticator.kubeConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- kubeConfig は、リモート Webhook サービスにアクセスする方法を説明する kube 設定ファイルデータを含むシークレットを参照します。参照されるシークレットのネームスペースは openshift-config です。詳細は、https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication を参照してください。キー "kubeConfig" を使用してデータを検索します。シークレットキーまたは期待されるキーが見つからない場合、Webhook は受け入れられません。指定された kube 設定データが無効な場合、Webhook は受け入れられません。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
3.1.5. .spec.webhookTokenAuthenticators リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- webhookTokenAuthenticators は非推奨であり、設定しても効果はありません。
- 型
-
array
3.1.6. .spec.webhookTokenAuthenticators[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- deprecatedWebhookTokenAuthenticator は、リモートトークンオーセンティケーターに必要な設定オプションを保持します。WebhookTokenAuthenticator と同じですが、KubeConfig フィールドの 'required' 検証がありません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| kubeConfig には、リモート Webhook サービスにアクセスする方法を説明する kube 設定ファイルデータが含まれています。詳細は、https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication を参照してください。キー "kubeConfig" を使用してデータを検索します。シークレットキーまたは期待されるキーが見つからない場合、Webhook は受け入れられません。指定された kube 設定データが無効な場合、Webhook は受け入れられません。このシークレットの名前空間は、使用場所によって決まります。 |
3.1.7. .spec.webhookTokenAuthenticators[].kubeConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- kubeConfig には、リモート Webhook サービスにアクセスする方法を説明する kube 設定ファイルデータが含まれています。詳細は、https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication を参照してください。キー "kubeConfig" を使用してデータを検索します。シークレットキーまたは期待されるキーが見つからない場合、Webhook は受け入れられません。指定された kube 設定データが無効な場合、Webhook は受け入れられません。このシークレットの名前空間は、使用場所によって決まります。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
3.1.8. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| integratedOAuthMetadata には、クラスター内統合 OAuth サーバーの OAuth 2.0 認証サーバー Metadata の検出エンドポイントデータが含まれています。この検出ドキュメントは、提供された場所 (oc get --raw '/.well-known/oauth-authorization-server') から表示できます。詳細は、IETF ドラフト (https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2) を参照してください。これには、クラスターの状態に基づく観測値が含まれます。spec.oauthMetadata に明示的に設定された値は、このフィールドよりも優先されます。認証 spec.type が IntegratedOAuth に設定されていない場合、このフィールドは意味がありません。キー "oauthMetadata" は、データを見つけるために使用されます。設定マップまたは予期されるキーが見つからない場合、メタデータは提供されません。指定されたメタデータが有効でない場合、メタデータは提供されません。この設定マップの namespace は openshift-config-managed です。 |
3.1.9. .status.integratedOAuthMetadata リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- integratedOAuthMetadata には、クラスター内統合 OAuth サーバーの OAuth 2.0 認証サーバー Metadata の検出エンドポイントデータが含まれています。この検出ドキュメントは、提供された場所 (oc get --raw '/.well-known/oauth-authorization-server') から表示できます。詳細は、IETF ドラフト (https://tools.ietf.org/html/draft-ietf-oauth-discovery-04#section-2) を参照してください。これには、クラスターの状態に基づく観測値が含まれます。spec.oauthMetadata に明示的に設定された値は、このフィールドよりも優先されます。認証 spec.type が IntegratedOAuth に設定されていない場合、このフィールドは意味がありません。キー "oauthMetadata" は、データを見つけるために使用されます。設定マップまたは予期されるキーが見つからない場合、メタデータは提供されません。指定されたメタデータが有効でない場合、メタデータは提供されません。この設定マップの namespace は openshift-config-managed です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
3.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/authentications-
DELETE: 認証のコレクションを削除します -
GET: 種類が Authentication のオブジェクトをリスト表示します。 -
POST: 認証を作成します
-
/apis/config.openshift.io/v1/authentications/{name}-
削除: 認証を削除します -
GET: 指定された Authentication を読み取ります。 -
PATCH: 指定された Authentication を部分的に更新します。 -
PUT: 指定された認証を置き換えます
-
/apis/config.openshift.io/v1/authentications/{name}/status-
GET: 指定された認証のステータスを読み取ります -
PATCH: 指定された Authentication のステータスを部分的に更新します。 -
PUT: 指定された認証のステータスを置き換えます
-
3.2.1. /apis/config.openshift.io/v1/authentications リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- 認証のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 認証の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- 認証の作成
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
3.2.2. /apis/config.openshift.io/v1/authentications/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 認証の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- 認証の削除
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された認証を読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された認証を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された認証を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
3.2.3. /apis/config.openshift.io/v1/authentications/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 認証の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された認証のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された認証のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された認証のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第4章 Build [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ビルドは、クラスター全体の OpenShift ビルドの動作を設定します。これには、BuildConfig オブジェクトでオーバーライドできるデフォルト設定と、すべてのビルドに適用されるオーバーライドが含まれます。正規名は "cluster" です。互換性レベル 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 ビルドコントローラー設定のユーザーが設定できる値を保持します。 |
4.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec ビルドコントローラー設定のユーザーが設定できる値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| AdditionalTrustedCA は、ビルド中のイメージのプッシュとプルで信頼される必要がある追加の CA を含む ConfigMap への参照です。この設定マップの namespace は openshift-config です。非推奨: イメージのプルおよびプッシュ用の追加の CA は、代わりに image.config.openshift.io/cluster に設定する必要があります。 |
|
|
| buildDefaults ビルドのデフォルト情報を制御します。 |
|
|
| buildOverrides ビルドの上書き設定を制御します。 |
4.1.2. .spec.additionalTrustedCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AdditionalTrustedCA は、ビルド中のイメージのプッシュとプルで信頼される必要がある追加の CA を含む ConfigMap への参照です。この設定マップの namespace は openshift-config です。非推奨: イメージのプルおよびプッシュ用の追加の CA は、代わりに image.config.openshift.io/cluster に設定する必要があります。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
4.1.3. .spec.buildDefaults リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- buildDefaults ビルドのデフォルト情報を制御します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
DefaultProxy には、イメージのプル/プッシュやソースのダウンロードなど、すべてのビルド操作のデフォルトのプロキシー設定が含まれています。ビルド設定の戦略で |
|
|
| Env は、指定された変数がビルドに存在しない場合にビルドに適用されるデフォルトの環境変数のセットです。 |
|
|
| EnvVar は、コンテナーに存在する環境変数を表します。 |
|
|
| GitProxy には、git 操作専用のプロキシー設定が含まれています。設定されている場合、これは git clone などのすべての git コマンドのプロキシー設定を上書きします。ここで設定されていない値は、DefaultProxy から継承されます。 |
|
|
| ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーは、Build/BuildConfig で同じ名前のラベルを指定することにより、デフォルトのラベルを上書きできます。 |
|
|
| |
|
|
| resources ビルドを実行するためのリソース要件を定義します。 |
4.1.4. .spec.buildDefaults.defaultProxy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
DefaultProxy には、イメージのプル/プッシュやソースのダウンロードなど、すべてのビルド操作のデフォルトのプロキシー設定が含まれています。ビルド設定の戦略で
HTTP_PROXY、HTTPS_PROXY、およびNO_PROXY環境変数を設定することにより、値を上書きできます。 - 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| httpProxy は、HTTP リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。 |
|
|
| httpsProxy は、HTTPS リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。 |
|
|
| noProxy は、プロキシーを使用してはならないホスト名や CIDR、IP のコンマ区切りのリストです。空は未設定を意味し、env 変数にはなりません。 |
|
|
| readinessEndpoints は、プロキシーの準備ができていることを確認するために使用されるエンドポイントのリストです。 |
|
|
| trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー "ca-bundle.crt" から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを "openshift-config-managed" namespace の "trusted-ca-bundle" という名前の ConfigMap に書き込むロールを担います。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap の namespace は "openshift-config" です。ConfigMap の例 (yaml): apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |
4.1.5. .spec.buildDefaults.defaultProxy.trustedCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー "ca-bundle.crt" から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを "openshift-config-managed" namespace の "trusted-ca-bundle" という名前の ConfigMap に書き込むロールを担います。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap の namespace は "openshift-config" です。ConfigMap (yaml) の例: apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
4.1.6. .spec.buildDefaults.env リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Env は、指定された変数がビルドに存在しない場合にビルドに適用されるデフォルトの環境変数のセットです。
- 型
-
array
4.1.7. .spec.buildDefaults.env[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- EnvVar は、コンテナーに存在する環境変数を表します。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 環境変数の名前。C_IDENTIFIER でなければなりません。 |
|
|
| 変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。 |
|
|
| 環境変数の値のソースです。値が空でない場合は使用できません。 |
4.1.8. .spec.buildDefaults.env[].valueFrom リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 環境変数の値のソースです。値が空でない場合は使用できません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ConfigMap のキーを選択します。 |
|
|
|
Pod のフィールドを選択します。metadata.name、metadata.namespace、 |
|
|
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。 |
|
|
| Pod の namespace でシークレットのキーを選択します |
4.1.9. .spec.buildDefaults.env[].valueFrom.configMapKeyRef リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConfigMap のキーを選択します。
- 型
-
object - 必須
-
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 選択するキー。 |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
4.1.10. .spec.buildDefaults.env[].valueFrom.fieldRef リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
Pod のフィールドを選択します。metadata.name、metadata.namespace、
metadata.labels['<KEY>']、metadata.annotations['<KEY>']、spec.nodeName、spec.serviceAccountName、status.hostIP、status.podIP、status.podIPs がサポートされています。 - 型
-
object - 必須
-
fieldPath
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
|
| 指定された API バージョンで選択するフィールドのパス。 |
4.1.11. .spec.buildDefaults.env[].valueFrom.resourceFieldRef リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。
- 型
-
object - 必須
-
resource
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
|
|
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 |
|
|
| 必須: 選択するリソース |
4.1.12. .spec.buildDefaults.env[].valueFrom.secretKeyRef リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod の namespace でシークレットのキーを選択します。
- 型
-
object - 必須
-
key
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: その他の便利なルール度を追加。apiVersion、kind、uid |
|
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
4.1.13. .spec.buildDefaults.gitProxy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GitProxy には、git 操作専用のプロキシー設定が含まれています。設定されている場合、これは git clone などのすべての git コマンドのプロキシー設定を上書きします。ここで設定されていない値は、DefaultProxy から継承されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| httpProxy は、HTTP リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。 |
|
|
| httpsProxy は、HTTPS リクエストのプロキシーの URL です。空は未設定を意味し、env 変数にはなりません。 |
|
|
| noProxy は、プロキシーを使用してはならないホスト名や CIDR、IP のコンマ区切りのリストです。空は未設定を意味し、env 変数にはなりません。 |
|
|
| readinessEndpoints は、プロキシーの準備ができていることを確認するために使用されるエンドポイントのリストです。 |
|
|
| trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー "ca-bundle.crt" から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを "openshift-config-managed" namespace の "trusted-ca-bundle" という名前の ConfigMap に書き込むロールを担います。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap の namespace は "openshift-config" です。ConfigMap の例 (yaml): apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE----- |
4.1.14. .spec.buildDefaults.gitProxy.trustedCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- trustedCA は、CA 証明書バンドルを含む ConfigMap への参照です。trustedCA フィールドは、プロキシーバリデーターによってのみ使用される必要があります。バリデーターは、必要なキー "ca-bundle.crt" から証明書バンドルを読み取り、それをシステムのデフォルトのトラストバンドルとマージし、マージされたトラストバンドルを "openshift-config-managed" namespace の "trusted-ca-bundle" という名前の ConfigMap に書き込むロールを担います。プロキシー接続を期待するクライアントは、プロキシーへのすべての HTTPS 要求に trusted-ca-bundle を使用する必要があり、非プロキシー HTTPS 要求にも trusted-ca-bundle を使用できます。trustedCA が参照する ConfigMap の namespace は "openshift-config" です。ConfigMap (yaml) の例: apiVersion: v1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: \| -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
4.1.15. .spec.buildDefaults.imageLabels リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーは、Build/BuildConfig で同じ名前のラベルを指定することにより、デフォルトのラベルを上書きできます。
- 型
-
array
4.1.16. .spec.buildDefaults.imageLabels[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name ラベルの名前を定義します。ゼロ以外の長さを持つ必要があります。 |
|
|
| 値は、ラベルのリテラル値を定義します。 |
4.1.17. .spec.buildDefaults.resources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- resources ビルドを実行するためのリソース要件を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
4.1.18. .spec.buildOverrides リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- buildOverrides ビルドの上書き設定を制御します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ForcePull は、設定されている場合、ビルド内の同等の値をオーバーライドします。つまり、false はすべてのビルドの強制プルを無効にし、true は、各ビルドがそれ自体を指定する内容に関係なく、すべてのビルドの強制プルを有効にします。 |
|
|
| ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーが Build/BuildConfig でこのリストにあるものと同じ名前のラベルを指定した場合、ユーザーのラベルは上書きされます。 |
|
|
| |
|
|
| NodeSelector は、ビルド Pod がノードに適合するために true である必要があるセレクターです。 |
|
|
| Tolerations は、ビルド Pod に設定されている既存の許容値を上書きする許容値のリストです。 |
|
|
| この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。 |
4.1.19. .spec.buildOverrides.imageLabels リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageLabels は、結果のイメージに適用される Docker ラベルのリストです。ユーザーが Build/BuildConfig でこのリストにあるものと同じ名前のラベルを指定した場合、ユーザーのラベルは上書きされます。
- 型
-
array
4.1.20. .spec.buildOverrides.imageLabels[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name ラベルの名前を定義します。ゼロ以外の長さを持つ必要があります。 |
|
|
| 値は、ラベルのリテラル値を定義します。 |
4.1.21. .spec.buildOverrides.tolerations リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Tolerations は、ビルド Pod に設定されている既存の許容値を上書きする許容値のリストです。
- 型
-
array
4.1.22. .spec.buildOverrides.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 の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
4.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/builds-
削除: ビルドのコレクションを削除します -
GET: ビルドの種類のオブジェクトをリスト表示します -
POST: ビルドを作成します
-
/apis/config.openshift.io/v1/builds/{name}-
削除: ビルドを削除します -
GET: 指定されたビルドを読み取ります -
PATCH: 指定されたビルドを部分的に更新します -
PUT: 指定されたビルドを置き換えます
-
/apis/config.openshift.io/v1/builds/{name}/status-
GET: 指定されたビルドのステータスを読み取ります -
PATCH: 指定されたビルドのステータスを部分的に更新します -
PUT: 指定されたビルドのステータスを置き換えます
-
4.2.1. /apis/config.openshift.io/v1/builds リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ビルドのコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類のオブジェクトをリスト表示する Build
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ビルドを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
4.2.2. /apis/config.openshift.io/v1/builds/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ビルドの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ビルドを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたビルドを読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたビルドを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたビルドを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
4.2.3. /apis/config.openshift.io/v1/builds/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ビルドの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定されたビルドのステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたビルドのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたビルドのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第5章 ClusterOperator [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterOperator は、Operator の現在の状態を保持するカスタムリソースオブジェクトです。このオブジェクトは、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 を参照してください。 | |
|
|
| spec は、任意の Operator に適用できる設定を保持します。 |
|
|
| status は、Operator の状態に関する情報を保持します。これは、Kubernetes エコシステム全体のステータス情報と一致しています。 |
5.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、任意の Operator に適用できる設定を保持します。
- 型
-
object
5.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は、Operator の状態に関する情報を保持します。これは、Kubernetes エコシステム全体のステータス情報と一致しています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 条件は、Operator の管理および監視対象コンポーネントの状態を表します。 |
|
|
| ClusterOperatorStatusCondition は、オペレーターの管理および監視対象コンポーネントの状態を表します。 |
|
| `` | 拡張機能には、このステータスオブジェクトを所有する Operator に固有の追加のステータス情報が含まれています。 |
|
|
| relatedObjects は、"興味深い" またはこの Operator に関連するオブジェクトのリストです。一般的な用途は次のとおりです。1。Operator を駆動する詳細なリソース 2.Operator の名前空間 3.オペランドの名前空間 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
|
| version は、Operator とオペランドのバージョンタプルのスライスです。複数のオペランドを管理する Operator は、配列内に複数のオペランドエントリーを持ちます。使用可能な Operator は、"operator" という名前の Operator 自体のバージョンを報告する必要があります。Operator は、新しいバージョンをすべてのオペランドにロールアウトすると、新しい "operator" バージョンを報告します。 |
|
|
|
5.1.3. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、Operator の管理および監視対象コンポーネントの状態を表します。
- 型
-
array
5.1.4. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterOperatorStatusCondition は、オペレーターの管理および監視対象コンポーネントの状態を表します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、現在のステータスプロパティーが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。改行文字 (U + 000A) が含まれている場合があり、改行としてレンダリングする必要があります。 |
|
|
| reason は、状態の現在のステータスの CamelCase の理由です。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| type は、この条件によって報告されるアスペクトを指定します。 |
5.1.7. .status.versions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- version は、Operator とオペランドのバージョンタプルのスライスです。複数のオペランドを管理する Operator は、配列内に複数のオペランドエントリーを持ちます。使用可能な Operator は、"operator" という名前の Operator 自体のバージョンを報告する必要があります。Operator は、新しいバージョンをすべてのオペランドにロールアウトすると、新しい "operator" バージョンを報告します。
- 型
-
array
5.1.8. .status.versions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object - 必須
-
name -
version
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、このバージョンの対象となる特定のオペランドの名前です。通常、Operator ではなく、コンテナーイメージと一致します。 |
|
|
| version は、特定のオペランドのどのバージョンが現在管理されているかを示します。常に Available オペランドと一致する必要があります。1.0.0 が使用可能である場合、Operator が 1.1.0 をロールアウトしようとしても、これは 1.0.0 を示している必要があります。 |
5.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/clusteroperators-
DELETE:ClusterOperator のコレクションを削除します -
GET: 種類 ClusterOperator のオブジェクトをリスト表示します -
POST:ClusterOperator を作成します
-
/apis/config.openshift.io/v1/clusteroperators/{name}-
削除:ClusterOperator を削除します -
GET: 指定された ClusterOperator を読み取ります -
PATCH: 指定された ClusterOperator を部分的に更新します -
PUT: 指定された ClusterOperator を置き換えます
-
/apis/config.openshift.io/v1/clusteroperators/{name}/status-
GET: 指定された ClusterOperator のステータスを読み取ります -
PATCH: 指定された ClusterOperator のステータスを部分的に更新します -
PUT: 指定された ClusterOperator のステータスを置き換えます
-
5.2.1. /apis/config.openshift.io/v1/clusteroperators リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ClusterOperator のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- ClusterOperator の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ClusterOperator を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
5.2.2. /apis/config.openshift.io/v1/clusteroperators/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterOperator の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ClusterOperator を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterOperator を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterOperator を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterOperator を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
5.2.3. /apis/config.openshift.io/v1/clusteroperators/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterOperator の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterOperator のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterOperator のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterOperator のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第6章 ClusterVersion [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterVersion は、ClusterVersionOperator の設定です。ここで、自動更新に関連するパラメーターを設定できます。互換性レベル 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 は、クラスターバージョンの望ましい状態です。Operator は、望ましいバージョンがクラスターに適用されていることを確認するために作業します。 |
|
|
| status には、利用可能な更新と進行中の更新に関する情報が含まれます。 |
6.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、クラスターバージョンの望ましい状態です。Operator は、望ましいバージョンがクラスターに適用されていることを確認するために作業します。
- 型
-
object - 必須
-
clusterID
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| capabilities は、オプションのコアクラスターコンポーネントのインストールを設定します。ここでの null 値は空のオブジェクトと同じです。デフォルトのセマンティクスについては子プロパティーを参照してください。 |
|
|
| channel は、デフォルト以外の一連の更新をこのクラスターに適用することを明示的に要求するための ID です。デフォルトのチャネルには、本番クラスターに適した安定した更新が含まれます。 |
|
|
| clusterID は、このクラスターを一意に識別します。これは、RFC4122 UUID 値 (16 進値の xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) であると予想されます。これは必須フィールドです。 |
|
|
| desiredUpdate は、クラスターバージョンの目的の値を示すオプションのフィールドです。この値を設定すると、アップグレードがトリガーされます (現在のバージョンが目的のバージョンと一致しない場合)。推奨される更新値のセットは、ステータスで利用可能な更新の一部としてリストされており、その範囲外の値を設定すると、アップグレードが失敗する可能性があります。availableUpdates または履歴にそのバージョンの更新が存在する場合は、イメージを設定せずにバージョンフィールドを指定できます。アップグレードが失敗した場合、Operator は停止し、失敗したコンポーネントに関するステータスを報告します。目的の更新値を以前のバージョンに戻すと、ロールバックが試行されます。すべてのロールバックが成功するわけではありません。 |
|
|
| オーバーライドは、クラスターバージョン Operator によって管理されるコンポーネントのオーバーライドのリストです。コンポーネントにマネージド外のマークを付けると、Operator はオブジェクトを作成または更新できなくなります。 |
|
|
| ComponentOverride を使用すると、コンポーネントに対するクラスターバージョン Operator の動作をオーバーライドできます。 |
|
|
| アップストリームを使用して、優先する更新サーバーを指定できます。デフォルトでは、クラスターとリージョンに適切な更新サーバーを使用します。 |
6.1.2. .spec.capabilities リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- capabilities は、オプションのコアクラスターコンポーネントのインストールを設定します。ここでの null 値は空のオブジェクトと同じです。デフォルトのセマンティクスについては子プロパティーを参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| additionalEnabledCapabilities は、baselineCapabilitySet で定義されたベースラインを超えて、管理対象ケイパビリティーのセットを拡張します。デフォルトは空のセットです。 |
|
|
| baselineCapabilitySet は、有効にするオプションのケイパビリティーの初期セットを選択します。これは、additionalEnabledCapabilities を使用して拡張できます。設定されていない場合、クラスターはデフォルトを選択しますが、デフォルトは時間の経過とともに変更される可能性があります。現在のデフォルトは vCurrent です。 |
6.1.3. .spec.desiredUpdate リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- desiredUpdate は、クラスターバージョンの目的の値を示すオプションのフィールドです。この値を設定すると、アップグレードがトリガーされます (現在のバージョンが目的のバージョンと一致しない場合)。推奨される更新値のセットは、ステータスで利用可能な更新の一部としてリストされており、その範囲外の値を設定すると、アップグレードが失敗する可能性があります。availableUpdates または履歴にそのバージョンの更新が存在する場合は、イメージを設定せずにバージョンフィールドを指定できます。アップグレードが失敗した場合、Operator は停止し、失敗したコンポーネントに関するステータスを報告します。目的の更新値を以前のバージョンに戻すと、ロールバックが試行されます。すべてのロールバックが成功するわけではありません。
- 型
-
object
| プロパティー | 型 | Description |
|---|---|---|
|
|
| force を使用すると、管理者は検証またはアップグレード可チェックに失敗したイメージに更新できます。このオプションは、提供されたイメージがクラスターへの完全な管理アクセスで実行されるため、提供されたイメージの信頼性が帯域外で検証された場合にのみ使用する必要があります。未知の、または潜在的に悪意のあるソースからのイメージには、このフラグを使用しないでください。 |
|
|
| image は、更新を含むコンテナーイメージの場所です。このフィールドが仕様の一部である場合、バージョンが指定されていて、availableUpdates フィールドに一致するバージョンが含まれている場合、イメージはオプションです。 |
|
|
| version は、更新バージョンを識別するセマンティックバージョニングです。このフィールドが仕様の一部である場合、イメージが指定されている場合、バージョンはオプションです。 |
6.1.4. .spec.overrides リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- オーバーライドは、クラスターバージョン Operator によって管理されるコンポーネントのオーバーライドのリストです。コンポーネントにマネージド外のマークを付けると、Operator はオブジェクトを作成または更新できなくなります。
- 型
-
array
6.1.5. .spec.overrides[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ComponentOverride を使用すると、コンポーネントに対するクラスターバージョン Operator の動作をオーバーライドできます。
- 型
-
object - 必須
-
group -
kind -
name -
namespace -
unmanaged
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| group は、種類が含まれる API グループを識別します。 |
|
|
| kind は、オーバーライドするオブジェクトを識別します。 |
|
|
| name はコンポーネントの名前です。 |
|
|
| 名前空間は、コンポーネントの名前空間です。リソースがクラスタースコープの場合、名前空間は空である必要があります。 |
|
|
| クラスターバージョン Operator がこのクラスター内のリソースの管理を停止する必要がある場合は、アンマネージドコントロール。デフォルト: false |
6.1.6. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status には、利用可能な更新と進行中の更新に関する情報が含まれます。
- 型
-
object - 必須
-
desired -
observedGeneration -
versionHash
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | availableUpdates には、このクラスターに推奨される更新が含まれています。conditionalUpdates に表示され、availableUpdates には表示されない更新は、このクラスターで既知の問題を引き起こす可能性があります。更新が推奨されていない場合、更新サービスが利用できない場合、または無効なチャネルが指定されている場合、このリストは空になる可能性があります。 |
|
|
| capabilities は、オプションのコアクラスターコンポーネントの状態を記述します。 |
|
|
| conditionalUpdates には、特定の必須条件を満たしている場合にこのクラスターに推奨される可能性のある更新のリストが含まれます。このクラスターに実際に推奨される更新セットに関心のあるコンシューマーは、availableUpdates を使用する必要があります。推奨される更新がない場合、更新サービスが利用できない場合、空または無効なチャネルが指定されている場合、このリストは空になる可能性があります。 |
|
|
| ConditionalUpdate は、現在のクラスターが調整しているバージョンを使用するクラスターの一部に推奨される更新を表しますが、その更新は現在のクラスターには推奨されない可能性があります。 |
|
|
| 条件は、クラスターのバージョンに関する情報を提供します。条件 "Available" は、desiredUpdate に達した場合に true に設定されます。更新が適用されている場合、条件 "Progressing" は true に設定されます。更新が一時的または永続的なエラーによって現在ブロックされている場合、条件 "Degraded" は true に設定されます。条件は、metadata.generation が status.generation と等しい場合に、現在の desiredUpdate に対してのみ有効です。 |
|
|
| ClusterOperatorStatusCondition は、オペレーターの管理および監視対象コンポーネントの状態を表します。 |
|
|
| 必要なのは、クラスターが調整しているバージョンです。クラスターがまだ完全に初期化されていない場合は、イメージやタグなどの利用可能な情報が必要になります。 |
|
|
| 履歴には、クラスターに適用された最新バージョンのリストが含まれます。この値は、クラスターの起動時に空になる場合があり、新しい更新が適用されるときに更新されます。最新の更新はリストの最初にあり、最新の順序で並べられています。ロールアウトが完了した場合、履歴の更新の状態は Completed になります。更新が失敗した場合、または途中で適用された場合、状態は Partial になります。限られた量の更新履歴のみが保持されます。 |
|
|
| UpdateHistory は、クラスターに対して 1 回試行された更新です。 |
|
|
| observedGeneration は、同期されている仕様のバージョンを報告します。この値が metadata.generation と等しくない場合、目的のフィールドと条件フィールドは以前のバージョンを表している可能性があります。 |
|
|
| versionHash は、クラスターが更新されるコンテンツのフィンガープリントです。不必要な作業を避けるために Operator が使用し、内部使用のみを目的としています。 |
6.1.7. .status.capabilities リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- capabilities は、オプションのコアクラスターコンポーネントの状態を記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| enabledCapabilities は、現在管理されているすべてのケイパビリティーをリスト表示します。 |
|
|
| knownCapabilities は、現在のクラスターにとって既知のケイパビリティーをすべてリスト表示します。 |
6.1.8. .status.conditionalUpdates リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditionalUpdates には、特定の必須条件を満たしている場合にこのクラスターに推奨される可能性のある更新のリストが含まれます。このクラスターに実際に推奨される更新セットに関心のあるコンシューマーは、availableUpdates を使用する必要があります。推奨される更新がない場合、更新サービスが利用できない場合、空または無効なチャネルが指定されている場合、このリストは空になる可能性があります。
- 型
-
array
6.1.9. .status.conditionalUpdates[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConditionalUpdate は、現在のクラスターが調整しているバージョンを使用するクラスターの一部に推奨される更新を表しますが、その更新は現在のクラスターには推奨されない可能性があります。
- 型
-
object - 必須
-
release -
risks
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、条件付き更新の現在のステータスの観察結果を表します。既知のタイプは次のとおりです。* クラスターバージョンの Operator が risks[].matchingRules を評価しようとするかどうかの評価。* 現在のクラスターに更新が推奨されるかどうかについて、推奨しています。 |
|
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
|
|
| release はターゲットとする更新です。 |
|
|
| risks は、ターゲットリリースへの更新に関連する問題を表します。cluster-version Operator はすべてのエントリーを評価し、1 つ以上のエントリーがあり、すべてのエントリーが更新を推奨している場合にのみ更新を推奨します。 |
|
|
| ConditionalUpdateRisk は、条件付き更新を推奨しない理由とクラスターの状態を表します。 |
6.1.10. .status.conditionalUpdates[].conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- conditions は、条件付き更新の現在のステータスの観察結果を表します。既知のタイプは次のとおりです。* クラスターバージョンの Operator が risks[].matchingRules を評価しようとするかどうかの評価。* 現在のクラスターに更新が推奨されるかどうかについて、推奨しています。
- 型
-
array
6.1.11. .status.conditionalUpdates[].conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"// other fields } - 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
6.1.12. .status.conditionalUpdates[].release リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- release はターゲットとする更新です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| チャネルは、リリースが現在属しているシンシナティチャネルのセットです。 |
|
|
| image は、更新を含むコンテナーイメージの場所です。このフィールドが仕様の一部である場合、バージョンが指定されていて、availableUpdates フィールドに一致するバージョンが含まれている場合、イメージはオプションです。 |
|
|
| url には、このリリースに関する情報が含まれています。この URL は、リリースの 'url' メタデータプロパティーまたは更新 API によって返されるメタデータによって設定され、ユーザーインターフェイスにリンクとして表示される必要があります。URL フィールドは、テストリリースまたは夜間リリースには設定されない場合があります。 |
|
|
| version は、更新バージョンを識別するセマンティックバージョニングです。このフィールドが仕様の一部である場合、イメージが指定されている場合、バージョンはオプションです。 |
6.1.13. .status.conditionalUpdates[].risks リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- risks は、ターゲットリリースへの更新に関連する問題を表します。cluster-version Operator はすべてのエントリーを評価し、1 つ以上のエントリーがあり、すべてのエントリーが更新を推奨している場合にのみ更新を推奨します。
- 型
-
array
6.1.14. .status.conditionalUpdates[].risks[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConditionalUpdateRisk は、条件付き更新を推奨しない理由とクラスターの状態を表します。
- 型
-
object - 必須
-
matchingRules -
message -
name -
url
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchingRules は、どのクラスターがリスクに一致し、どのクラスターが一致しないかを決定するための条件スライスです。スライスは優先度の降順で並べられます。cluster-version Operator はスライスを順番に処理し、最初に正常に評価できたスライスの後で停止します。正常に評価できる条件がない場合、更新は推奨されません。 |
|
|
| ClusterCondition は、タイプが指定されたクラスター条件の結合です。'type' プロパティーは、どのタイプ固有のプロパティーが該当するか決定します。クラスターで評価されると、条件は一致、不一致、または評価失敗となります。 |
|
|
| message は、matchingRules がクラスターの状態と一致する場合の、更新リスクに関する追加情報を提供します。これは人間によってのみ消費されます。改行文字 (U + 000A) が含まれている場合があり、改行としてレンダリングする必要があります。 |
|
|
| name は、matchingRules がクラスターの状態と一致する場合の、条件付き更新を推奨しない理由 (CamelCase) です。 |
|
|
| url には、このリスクに関する情報が含まれています。 |
6.1.15. .status.conditionalUpdates[].risks[].matchingRules リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- matchingRules は、どのクラスターがリスクに一致し、どのクラスターが一致しないかを決定するための条件スライスです。スライスは優先度の降順で並べられます。cluster-version Operator はスライスを順番に処理し、最初に正常に評価できたスライスの後で停止します。正常に評価できる条件がない場合、更新は推奨されません。
- 型
-
array
6.1.16. .status.conditionalUpdates[].risks[].matchingRules[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterCondition は、タイプが指定されたクラスター条件の結合です。'type' プロパティーは、どのタイプ固有のプロパティーが該当するか決定します。クラスターで評価されると、条件は一致、不一致、または評価失敗となります。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| promQL は、PromQL に基づくクラスター条件を表します。 |
|
|
| type はクラスター条件のタイプを表します。これにより、追加のプロパティーのメンバーとセマンティクスが定義されます。 |
6.1.17. .status.conditionalUpdates[].risks[].matchingRules[].promql リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- promQL は、PromQL に基づくクラスター条件を表します。
- 型
-
object - 必須
-
promql
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| PromQL はクラスターを分類する PromQL クエリーです。このクエリーは、一致する場合は 1 を返し、一致しない場合は 0 を返します。時系列を返さないクエリーや、0 または 1 以外の値を返すクエリーは、評価失敗です。 |
6.1.18. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、クラスターのバージョンに関する情報を提供します。条件 "Available" は、desiredUpdate に達した場合に true に設定されます。更新が適用されている場合、条件 "Progressing" は true に設定されます。更新が一時的または永続的なエラーによって現在ブロックされている場合、条件 "Degraded" は true に設定されます。条件は、metadata.generation が status.generation と等しい場合に、現在の desiredUpdate に対してのみ有効です。
- 型
-
array
6.1.19. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ClusterOperatorStatusCondition は、オペレーターの管理および監視対象コンポーネントの状態を表します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、現在のステータスプロパティーが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。改行文字 (U + 000A) が含まれている場合があり、改行としてレンダリングする必要があります。 |
|
|
| reason は、状態の現在のステータスの CamelCase の理由です。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| type は、この条件によって報告されるアスペクトを指定します。 |
6.1.20. .status.desired リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 必要なのは、クラスターが調整しているバージョンです。クラスターがまだ完全に初期化されていない場合は、イメージやタグなどの利用可能な情報が必要になります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| チャネルは、リリースが現在属しているシンシナティチャネルのセットです。 |
|
|
| image は、更新を含むコンテナーイメージの場所です。このフィールドが仕様の一部である場合、バージョンが指定されていて、availableUpdates フィールドに一致するバージョンが含まれている場合、イメージはオプションです。 |
|
|
| url には、このリリースに関する情報が含まれています。この URL は、リリースの 'url' メタデータプロパティーまたは更新 API によって返されるメタデータによって設定され、ユーザーインターフェイスにリンクとして表示される必要があります。URL フィールドは、テストリリースまたは夜間リリースには設定されない場合があります。 |
|
|
| version は、更新バージョンを識別するセマンティックバージョニングです。このフィールドが仕様の一部である場合、イメージが指定されている場合、バージョンはオプションです。 |
6.1.21. .status.history リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 履歴には、クラスターに適用された最新バージョンのリストが含まれます。この値は、クラスターの起動時に空になる場合があり、新しい更新が適用されるときに更新されます。最新の更新はリストの最初にあり、最新の順序で並べられています。ロールアウトが完了した場合、履歴の更新の状態は Completed になります。更新が失敗した場合、または途中で適用された場合、状態は Partial になります。限られた量の更新履歴のみが保持されます。
- 型
-
array
6.1.22. .status.history[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- UpdateHistory は、クラスターに対して 1 回試行された更新です。
- 型
-
object - 必須
-
image -
startedTime -
state -
verified
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| acceptedRisks は、更新を開始するために受け入れられたリスクを記録します。たとえば、Upgradeable=False または desiredUpdate.force によってオーバーライドされた署名が見つからないこと、または推奨される更新ターゲットの availableUpdates セットに含まれていないにもかかわらず開始された更新を言及します。 |
|
| `` | 設定されている場合、completionTime は、更新が完全に適用されたときです。現在適用されている更新の完了時間は null になります。完了時間は、現在の更新ではないエントリー (通常は次の更新の開始時間) に常に設定されます。 |
|
|
| image は、更新を含むコンテナーイメージの場所です。この値は常に入力されます。 |
|
|
| startedTime は、更新が開始された時刻です。 |
|
|
| 状態は、更新が完全に適用されたかどうかを反映します。部分状態は、更新が完全に適用されていないことを示し、完了状態は、更新が少なくとも 1 回正常にロールアウトされたことを示します (更新のすべての部分が正常に適用されました)。 |
|
|
| 検証済みは、提供された更新がインストール前に適切に検証されたかどうかを示します。これが false の場合、クラスターは信頼されていない可能性があります。verified では、更新ターゲットが受け入れられた時点でのクラスターの状態に依存するアップグレード可能チェックはカバーされません。 |
|
|
| version は、更新バージョンを識別するセマンティックバージョニングです。要求されたイメージがバージョンを定義していない場合、またはイメージの取得に失敗した場合、この値は空である可能性があります。 |
6.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/clusterversions-
DELETE:ClusterVersion のコレクションを削除します -
GET: 種類 ClusterVersion のオブジェクトをリスト表示します -
POST:ClusterVersion を作成します
-
/apis/config.openshift.io/v1/clusterversions/{name}-
削除:ClusterVersion を削除します -
GET: 指定された ClusterVersion を読み取ります -
PATCH: 指定された ClusterVersion を部分的に更新します -
PUT: 指定された ClusterVersion を置き換えます
-
/apis/config.openshift.io/v1/clusterversions/{name}/status-
GET: 指定された ClusterVersion のステータスを読み取ります -
PATCH: 指定された ClusterVersion のステータスを部分的に更新します -
PUT: 指定された ClusterVersion のステータスを置き換えます
-
6.2.1. /apis/config.openshift.io/v1/clusterversions リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ClusterVersion のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- ClusterVersion の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ClusterVersion を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
6.2.2. /apis/config.openshift.io/v1/clusterversions/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterVersion の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ClusterVersion を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterVersion を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterVersion を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterVersion を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
6.2.3. /apis/config.openshift.io/v1/clusterversions/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ClusterVersion の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された ClusterVersion のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ClusterVersion のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ClusterVersion のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第7章 Console [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
コンソールは、ログアウト URL を含む Web コンソールのクラスター全体の設定を保持し、コンソールのパブリック URL を報告します。正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object - 必須
-
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 を参照してください。 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
7.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ConsoleAuthentication は、コンソール認証のオプション設定のリストを定義します。 |
7.1.2. .spec.authentication リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ConsoleAuthentication は、コンソール認証のオプション設定のリストを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Web コンソールからログアウトした後に Web ブラウザーをリダイレクトするオプションの絶対 URL です。指定しない場合、デフォルトのログインページにリダイレクトされます。これは、次のような Single Sign-On (SSO) をサポートする ID プロバイダーを使用する場合に必要です。-OpenID(Keycloak、Azure)-RequestHeader (GSSAPI、SSPI、SAML)-OAuth (GitHub、GitLab、Google) コンソールからのログアウトユーザーのトークンを破棄します。logoutRedirect は、ユーザーに ID プロバイダーを介してシングルログアウト (SLO) を実行し、Single Sign-On セッションを破棄するオプションを提供します。 |
7.1.3. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| コンソールの URL。これは、コンソール用に作成されたルートのホストから取得されます。 |
7.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/consoles-
削除: コンソールのコレクションを削除します -
GET: 種類が Console のオブジェクトをリスト表示します。 -
POST: コンソールを作成します
-
/apis/config.openshift.io/v1/consoles/{name}-
削除: コンソールを削除します -
GET: 指定された Console を読み取ります。 -
PATCH: 指定された Console を部分的に更新します。 -
PUT: 指定されたコンソールを交換します
-
/apis/config.openshift.io/v1/consoles/{name}/status-
GET: 指定されたコンソールのステータスを読み取ります -
PATCH: 指定されたコンソールのステータスを部分的に更新します -
PUT: 指定されたコンソールのステータスを置き換えます
-
7.2.1. /apis/config.openshift.io/v1/consoles リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- コンソールのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類のオブジェクトをリスト表示するコンソール
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- コンソールを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
7.2.2. /apis/config.openshift.io/v1/consoles/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| コンソールの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- コンソールを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたコンソールを読む
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたコンソールを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたコンソールを交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
7.2.3. /apis/config.openshift.io/v1/consoles/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| コンソールの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定されたコンソールのステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたコンソールのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたコンソールのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第8章 DNS [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
DNS は、DNS に関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object - 必須
-
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 を参照してください。 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
8.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
baseDomain は、クラスターのベースドメインです。すべてのマネージド DNS レコードは、このベースのサブドメインになります。たとえば、ベースドメイン |
|
|
| platform は、DNS の基盤となるインフラストラクチャープロバイダーに固有の設定を保持します。これを省略した場合、ユーザーには選択する意図がないことを意味し、プラットフォームが適切なデフォルトを選択します。これらのデフォルトは時間の経過とともに変更される可能性があります。 |
|
|
| privateZone は、クラスターの内部でのみ使用可能なすべての DNS レコードが存在する場所です。このフィールドが nil の場合、プライベートレコードは作成されません。一度設定すると、このフィールドは変更できません。 |
|
|
| publicZone は、インターネットに公的にアクセス可能なすべての DNS レコードが存在する場所です。このフィールドが nil の場合、公開レコードは作成されません。一度設定すると、このフィールドは変更できません。 |
8.1.2. .spec.platform リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- platform は、DNS の基盤となるインフラストラクチャープロバイダーに固有の設定を保持します。これを省略した場合、ユーザーには選択する意図がないことを意味し、プラットフォームが適切なデフォルトを選択します。これらのデフォルトは時間の経過とともに変更される可能性があります。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| aws には、Amazon Web Services クラウドプロバイダー固有の DNS 設定が含まれています。 |
|
|
| type は、クラスターの基盤となるインフラストラクチャープロバイダーです。使用できる値は ""、"AWS" です。個々のコンポーネントはすべてのプラットフォームをサポートしていない可能性があり、認識されないプラットフォームは最善のデフォルトで処理する必要があります。 |
8.1.3. .spec.platform.aws リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- aws には、Amazon Web Services クラウドプロバイダー固有の DNS 設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| privateZoneIAMRole には、IAM ロールの ARN が含まれます。これは、クラスター DNS 設定で指定されたクラスターのプライベートホストゾーンで操作を実行するときに想定されます。空のままにしておくと、ロールは想定されません。 |
8.1.4. .spec.privateZone リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- privateZone は、クラスターの内部でのみ使用可能なすべての DNS レコードが存在する場所です。このフィールドが nil の場合、プライベートレコードは作成されません。一度設定すると、このフィールドは変更できません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
AWS では [1] で |
|
|
|
タグを使用して DNS ホストゾーンを照会することができます。AWS では、resourcegroupstaggingapi [1] を使用して、 |
8.1.5. .spec.publicZone リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- publicZone は、インターネットに公的にアクセス可能なすべての DNS レコードが存在する場所です。このフィールドが nil の場合、公開レコードは作成されません。一度設定すると、このフィールドは変更できません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
AWS では [1] で |
|
|
|
タグを使用して DNS ホストゾーンを照会することができます。AWS では、resourcegroupstaggingapi [1] を使用して、 |
8.1.6. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
8.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/dnses-
DELETE: DNS のコレクションを削除します -
GET: 種類が DNS のオブジェクトをリスト表示します。 -
POST: DNS を作成します
-
/apis/config.openshift.io/v1/dnses/{name}-
DELETE: DNS を削除します -
GET: 指定された DNS を読み取ります。 -
PATCH: 指定された DNS を部分的に更新します。 -
PUT: 指定された DNS を置き換えます
-
/apis/config.openshift.io/v1/dnses/{name}/status-
GET: 指定された DNS のステータスを読み取ります -
PATCH: 指定された DNS のステータスを部分的に更新します -
PUT: 指定された DNS のステータスを置き換えます
-
8.2.1. /apis/config.openshift.io/v1/dnses リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- DNS のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- DNS の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- DNS を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
8.2.2. /apis/config.openshift.io/v1/dnses/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| DNS の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- DNS を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された DNS を読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された DNS を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された DNS を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
8.2.3. /apis/config.openshift.io/v1/dnses/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| DNS の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された DNS のステータスを読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された DNS のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された DNS のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第9章 FeatureGate [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
機能は、機能ゲートに関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 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
| プロパティー | 型 | 説明 |
|---|---|---|
|
| `` | customNoUpgrade を使用すると、任意の機能を有効または無効にできます。この機能セットをオンにすることはサポートされておらず、元に戻すことはできず、アップグレードを防止します。その性質上、この設定は検証できません。タイプミスがある場合、または誤って無効な組み合わせを適用した場合、クラスターが回復不能な方法で失敗する可能性があります。このフィールドを使用するには、featureSet が "CustomNoUpgrade" と等しくなるように設定する必要があります。 |
|
|
| featureSet は、クラスター内の機能のリストを変更します。デフォルトは空です。この設定の調整には十分注意してください。機能をオンまたはオフにすると、クラスターに元に戻せない不可逆的な変更が発生する可能性があります。 |
9.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
9.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/featuregates-
DELETE:FeatureGate のコレクションを削除します -
GET:FeatureGate の種類のオブジェクトをリスト表示します -
POST:FeatureGate を作成します
-
/apis/config.openshift.io/v1/featuregates/{name}-
削除:FeatureGate を削除します -
GET: 指定された FeatureGate を読み取ります -
PATCH: 指定された FeatureGate を部分的に更新します -
PUT: 指定された FeatureGate を置き換えます
-
/apis/config.openshift.io/v1/featuregates/{name}/status-
GET: 指定された FeatureGate のステータスを読み取ります -
PATCH: 指定された FeatureGate のステータスを部分的に更新します -
PUT: 指定された FeatureGate のステータスを置き換えます
-
9.2.1. /apis/config.openshift.io/v1/featuregates リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- FeatureGate のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類のオブジェクトをリスト表示する FeatureGate
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- FeatureGate を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
9.2.2. /apis/config.openshift.io/v1/featuregates/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| FeatureGate の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- FeatureGate を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された FeatureGate を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された FeatureGate を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された FeatureGate を交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
9.2.3. /apis/config.openshift.io/v1/featuregates/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| FeatureGate の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された FeatureGate のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された FeatureGate のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された FeatureGate のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第10章 HelmChartRepository [helm.openshift.io/v1beta1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- HelmChartRepository は、プロキシーされた Helm チャートリポジトリーのクラスター全体の設定を保持します。互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (いずれか長い方) の間安定しています。
- 型
-
object - 必須
-
spec
-
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 は、ユーザーが設定可能な設定値を保持します。 |
|
|
| クラスター内のリポジトリーの監視されたステータス。 |
10.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| チャートリポジトリーに接続するために必要な設定 |
|
|
| オプションの人間が読めるリポジトリーの説明。UI で表示目的で使用できます。 |
|
|
| true に設定すると、クラスター/namespace でのリポジトリーの使用が無効になります |
|
|
| オプションの関連する人間が読めるリポジトリー名。UI で表示目的で使用できます。 |
10.1.2. .spec.connectionConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- チャートリポジトリーに接続するために必要な設定
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca-bundle.crt" は、データを見つけるために使用されます。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。 |
|
|
| tlsClientConfig は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書と秘密鍵を含む名前によるシークレットへのオプションの参照です。キー "tls.crt" は、クライアント証明書を見つけるために使用されます。キー "tls.key" は、秘密キーを見つけるために使用されます。このシークレットの名前空間は openshift-config です。 |
|
|
| チャートリポジトリーの URL |
10.1.3. .spec.connectionConfig.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca-bundle.crt" は、データを見つけるために使用されます。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
10.1.4. .spec.connectionConfig.tlsClientConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tlsClientConfig は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書と秘密鍵を含む名前によるシークレットへのオプションの参照です。キー "tls.crt" は、クライアント証明書を見つけるために使用されます。キー "tls.key" は、秘密キーを見つけるために使用されます。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
10.1.5. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- クラスター内のリポジトリーの監視されたステータス。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 条件は、条件とそのステータスのリストです |
|
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
10.1.6. .status.conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、条件とそのステータスのリストです
- 型
-
array
10.1.7. .status.conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"// other fields } - 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
10.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/helm.openshift.io/v1beta1/helmchartrepositories-
DELETE:HelmChartRepository のコレクションを削除します -
GET: 種類 HelmChartRepository のオブジェクトをリスト表示します -
POST:HelmChartRepository を作成します
-
/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}-
削除:HelmChartRepository を削除します -
GET: 指定された HelmChartRepository を読み取ります -
PATCH: 指定された HelmChartRepository を部分的に更新します -
PUT: 指定された HelmChartRepository を置き換えます
-
/apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status-
GET: 指定された HelmChartRepository のステータスを読み取ります -
PATCH: 指定された HelmChartRepository のステータスを部分的に更新します -
PUT: 指定された HelmChartRepository のステータスを置き換えます
-
10.2.1. /apis/helm.openshift.io/v1beta1/helmchartrepositories リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- HelmChartRepository のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- HelmChartRepository の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- HelmChartRepository を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
10.2.2. /apis/helm.openshift.io/v1beta1/helmchartrepositories/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HelmChartRepository の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- HelmChartRepository を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された HelmChartRepository を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された HelmChartRepository を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された HelmChartRepository を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
10.2.3. /apis/helm.openshift.io/v1beta1/helmchartrepositories/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| HelmChartRepository の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された HelmChartRepository のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された HelmChartRepository のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された HelmChartRepository のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第11章 Image [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- イメージは、イメージストリームのインポートと外部レジストリーのランタイム設定に関連するポリシーを管理します。これにより、クラスター管理者は、OpenShift がイメージのインポートを許可されるレジストリー、外部レジストリー用の追加の CA トラストバンドル、およびレジストリーのホスト名をブロックまたは許可するポリシーを設定できます。OpenShift のイメージレジストリーを公開する場合、これによりクラスター管理者は外部ホスト名を指定することもできます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
spec
-
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 は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
11.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| additionalTrustedCA は、イメージストリームのインポート、Pod イメージのプル、ビルドイメージのプル、およびイメージレジストリーのプルスルー中に信頼される必要がある追加の CA を含む ConfigMap への参照です。この設定マップの namespace は openshift-config です。 |
|
|
| allowedRegistriesForImport は、通常のユーザーがイメージをインポートできるコンテナーイメージレジストリーを制限します。このリストを、有効な Docker イメージを含むものとユーザーが信頼し、アプリケーションのインポート元となるレジストリーに設定します。Images または ImageStreamMappings を API 経由で作成するパーミッションを持つユーザーは、このポリシーによる影響を受けません。通常、これらのパーミッションを持っているのは管理者またはシステム統合管理者のみです。 |
|
|
| RegistryLocation には、レジストリードメイン名で指定されたレジストリーの場所が含まれます。ドメイン名には、'*' や '??' などのワイルドカードが含まれる場合があります。 |
|
|
| externalRegistryHostnames デフォルトの外部イメージレジストリーのホスト名を指定します。外部ホスト名は、イメージレジストリーが外部に公開される場合にのみ設定される必要があります。最初の値は、イメージストリームの 'publicDockerImageRepository' フィールドで使用されます。値は "hostname[:port]" 形式の値である必要があります。 |
|
|
| registrySources には、ビルド +Pod のイメージにアクセスするときにコンテナーランタイムが個々のレジストリーをどのように処理するかを決定する設定が含まれています。(たとえば、安全でないアクセスを許可するかどうか)。内部クラスターレジストリーの設定は含まれません。 |
11.1.2. .spec.additionalTrustedCA リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- additionalTrustedCA は、イメージストリームのインポート、Pod イメージのプル、ビルドイメージのプル、およびイメージレジストリーのプルスルー中に信頼される必要がある追加の CA を含む ConfigMap への参照です。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
11.1.3. .spec.allowedRegistriesForImport リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- allowedRegistriesForImport は、通常のユーザーがイメージをインポートできるコンテナーイメージレジストリーを制限します。このリストを、有効な Docker イメージを含むものとユーザーが信頼し、アプリケーションのインポート元となるレジストリーに設定します。Images または ImageStreamMappings を API 経由で作成するパーミッションを持つユーザーは、このポリシーによる影響を受けません。通常、これらのパーミッションを持っているのは管理者またはシステム統合管理者のみです。
- 型
-
array
11.1.4. .spec.allowedRegistriesForImport[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- RegistryLocation には、レジストリードメイン名で指定されたレジストリーの場所が含まれます。ドメイン名には、'*' や '??' などのワイルドカードが含まれる場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| domainName は、レジストリーのドメイン名を指定します。レジストリーが非標準 (80 または 443) ポートを使用する場合は、そのポートもドメイン名に含める必要があります。 |
|
|
| insecure は、レジストリーが安全 (https) であるか安全でない (http) かを示します。デフォルト (指定されていない場合) では、レジストリーは安全であると見なされます。 |
11.1.5. .spec.registrySources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- registrySources には、ビルド +Pod のイメージにアクセスするときにコンテナーランタイムが個々のレジストリーをどのように処理するかを決定する設定が含まれています。(たとえば、安全でないアクセスを許可するかどうか)。内部クラスターレジストリーの設定は含まれません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| allowedRegistries は、イメージのプルおよびプッシュアクションに許可されている唯一のレジストリーです。他のすべてのレジストリーは拒否されます。blockedRegistries または allowedRegistries のいずれかのみを設定できます。 |
|
|
| blockedRegistries は、イメージのプルおよびプッシュアクションには使用できません。他のすべてのレジストリーは許可されます。blockedRegistries または allowedRegistries のいずれかのみを設定できます。 |
|
|
| containerRuntimeSearchRegistries は、プル仕様に完全修飾ドメインがないイメージをプルするときに検索されるレジストリーです。レジストリーは、リストに示されている順序で検索されます。注: この検索リストは、コンテナーランタイム、つまり CRI-O でのみ機能します。ビルドまたはイメージストリームのインポートでは機能しません。 |
|
|
| insecureRegistries は、有効な TLS 証明書を持たないか、HTTP 接続のみをサポートするレジストリーです。 |
11.1.6. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| externalRegistryHostnames デフォルトの外部イメージレジストリーのホスト名を指定します。外部ホスト名は、イメージレジストリーが外部に公開される場合にのみ設定される必要があります。最初の値は、イメージストリームの 'publicDockerImageRepository' フィールドで使用されます。値は "hostname[:port]" 形式の値である必要があります。 |
|
|
| internalRegistryHostname は、デフォルトの内部イメージレジストリーのホスト名を設定します。値は "hostname[:port]" 形式の値である必要があります。この値は、内部レジストリーのホスト名を制御するイメージレジストリー Operator によって設定されます。後方互換性を考慮して、ユーザーは引き続き OPENSHIFT_DEFAULT_REGISTRY 環境変数を使用できますが、この設定はこの環境変数を上書きします。 |
11.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/images-
削除: イメージのコレクションを削除します -
GET: 種類のオブジェクトをリスト表示する Image -
POST: イメージを作成する
-
/apis/config.openshift.io/v1/images/{name}-
削除: イメージを削除します -
GET: 指定されたイメージを読み取ります -
PATCH: 指定されたイメージを部分的に更新します -
PUT: 指定されたイメージを置き換えます
-
/apis/config.openshift.io/v1/images/{name}/status-
GET: 指定されたイメージのステータスを読み取ります -
PATCH: 指定されたイメージのステータスを部分的に更新します -
PUT: 指定されたイメージのステータスを置き換えます
-
11.2.1. /apis/config.openshift.io/v1/images リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- イメージのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類のオブジェクトをリスト表示するイメージ
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- イメージの作成
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
11.2.2. /apis/config.openshift.io/v1/images/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イメージの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- イメージを削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたイメージを読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定したイメージを部分的に更新する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたイメージを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
11.2.3. /apis/config.openshift.io/v1/images/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イメージの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定されたイメージのステータスを読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたイメージのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたイメージのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第12章 ImageContentPolicy [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ImageContentPolicy は、レジストリーミラールールの処理方法に関するクラスター全体の情報を保持します。複数のポリシーが定義されている場合、動作の結果は各フィールドで定義されます。互換性レベル 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 を参照してください。 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
12.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
repositoryDigestMirrors を使用すると、Pod 内のイメージダイジェストによって参照されるイメージを、ミラーリングされた代替のリポジトリーの場所から取得できます。Pod に提供されるイメージプル仕様は、RepositoryDigestMirrors で説明されているソースの場所と比較され、管理者が潜在的に高速なミラーを選択できるように、指定されたリポジトリーではなく、リスト内の任意のミラーからイメージをプルダウンできます。タグによってミラーからイメージをプルするには、"allowMirrorByTags" を設定する必要があります。各 "source" リポジトリーは独立して扱われます。異なる "ソース" リポジトリーの設定は相互作用しません。"ミラー" が指定されていない場合、イメージはプル仕様で指定されたリポジトリーから引き続きプルされます。同じ "ソース" リポジトリーに対して複数のポリシーが定義されている場合、定義されたミラーのセットは一緒にマージされ、可能であればミラーの相対的な順序が維持されます。たとえば、ポリシー A にミラー |
|
|
| RepositoryDigestMirrors は、レジストリー設定でミラーを処理する方法に関するクラスター全体の情報を保持します。 |
12.1.2. .spec.repositoryDigestMirrors リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
repositoryDigestMirrors を使用すると、Pod 内のイメージダイジェストによって参照されるイメージを、ミラーリングされた代替のリポジトリーの場所から取得できます。Pod に提供されるイメージプル仕様は、RepositoryDigestMirrors で説明されているソースの場所と比較され、管理者が潜在的に高速なミラーを選択できるように、指定されたリポジトリーではなく、リスト内の任意のミラーからイメージをプルダウンできます。タグによってミラーからイメージをプルするには、"allowMirrorByTags" を設定する必要があります。各 "source" リポジトリーは独立して扱われます。異なる "ソース" リポジトリーの設定は相互作用しません。"ミラー" が指定されていない場合、イメージはプル仕様で指定されたリポジトリーから引き続きプルされます。同じ "ソース" リポジトリーに対して複数のポリシーが定義されている場合、定義されたミラーのセットは一緒にマージされ、可能であればミラーの相対的な順序が維持されます。たとえば、ポリシー A にミラー
a、b、cがあり、ポリシー B にミラーc、d、eがある場合、ミラーはa、b、c、d、eの順序で使用されます。ミラーエントリーの順序が競合する場合 (たとえばa, bb, a) 設定は拒否されませんが、結果の順序は指定されていません。 - 型
-
array
12.1.3. .spec.repositoryDigestMirrors[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- RepositoryDigestMirrors は、レジストリー設定でミラーを処理する方法に関するクラスター全体の情報を保持します。
- 型
-
object - 必須
-
source
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| allowMirrorByTags が true の場合、ミラーを使用して、タグによって参照されるイメージをプルできます。デフォルトは false です。ミラーは、ダイジェストによって参照されるイメージをプルするときにのみ機能します。タグでイメージをプルすると、プル元のエンドポイントに応じて、異なるイメージが生成される可能性があります。ミラーにダイジェストプルを強制すると、その問題を回避できます。 |
|
|
| ミラーは、同じイメージを含む可能性のある 0 個以上のリポジトリーです。"ミラー" が指定されていない場合、イメージはプル仕様で指定されたリポジトリーから引き続きプルされます。ミラーは設定されません。このリスト内のミラーの順序はユーザーの希望する優先度として扱われますが、ソースはデフォルトですべてのミラーよりも低い優先度と見なされます。他の repositoryDigestMirrors オブジェクトを含む (ただしこれらに限定されない) 他のクラスター設定は、ミラーが接続される正確な順序に影響を与える可能性があります。 |
|
|
| source は、たとえばイメージプル仕様でユーザーが参照するリポジトリーです。 |
12.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/imagecontentpolicies-
DELETE:ImageContentPolicy のコレクションを削除します -
GET:ImageContentPolicy の種類のオブジェクトをリスト表示します -
POST:ImageContentPolicy を作成します
-
/apis/config.openshift.io/v1/imagecontentpolicies/{name}-
削除:ImageContentPolicy を削除します -
GET: 指定された ImageContentPolicy を読み取ります -
PATCH: 指定された ImageContentPolicy を部分的に更新します -
PUT: 指定された ImageContentPolicy を置き換えます
-
/apis/config.openshift.io/v1/imagecontentpolicies/{name}/status-
GET: 指定された ImageContentPolicy のステータスを読み取ります -
PATCH: 指定された ImageContentPolicy のステータスを部分的に更新します -
PUT: 指定された ImageContentPolicy のステータスを置き換えます
-
12.2.1. /apis/config.openshift.io/v1/imagecontentpolicies リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ImageContentPolicy のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類のオブジェクトをリスト表示する ImageContentPolicy
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ImageContentPolicy を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
12.2.2. /apis/config.openshift.io/v1/imagecontentpolicies/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ImageContentPolicy の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ImageContentPolicy を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ImageContentPolicy を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ImageContentPolicy を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ImageContentPolicy を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
12.2.3. /apis/config.openshift.io/v1/imagecontentpolicies/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ImageContentPolicy の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された ImageContentPolicy のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ImageContentPolicy のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ImageContentPolicy のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第13章 Infrastructure [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
インフラストラクチャーは、インフラストラクチャーに関するクラスター全体の情報を保持します。正規名は
クラスター互換性レベル 1 です。メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
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 は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
13.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
|
cloudConfig は、クラウドプロバイダー設定ファイルを含む ConfigMap への参照です。この設定ファイルは、組み込みのクラウドプロバイダー統合または外部クラウドコントローラーマネージャーを使用するときに、Kubernetes クラウドプロバイダー統合を設定するために使用されます。この設定マップのネームスペースは openshift-config です。cloudConfig は、kube_cloud_config コントローラーによってのみ使用されます。コントローラーは、さまざまなプラットフォームの仕様でユーザー設定を使用し、それをこのフィールドでユーザーが提供した ConfigMap と組み合わせて、ステッチされた kube クラウド設定を作成する責任があります。コントローラーは、 |
|
|
| platformSpec は、基盤となるインフラストラクチャープロバイダーに固有の必要な情報を保持します。 |
13.1.2. .spec.cloudConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
cloudConfig は、クラウドプロバイダー設定ファイルを含む ConfigMap への参照です。この設定ファイルは、組み込みのクラウドプロバイダー統合または外部クラウドコントローラーマネージャーを使用するときに、Kubernetes クラウドプロバイダー統合を設定するために使用されます。この設定マップのネームスペースは openshift-config です。cloudConfig は、kube_cloud_config コントローラーによってのみ使用されます。コントローラーは、さまざまなプラットフォームの仕様でユーザー設定を使用し、それをこのフィールドでユーザーが提供した ConfigMap と組み合わせて、ステッチされた kube クラウド設定を作成する責任があります。コントローラーは、
openshift-config-managed名前空間に ConfigMap kube-cloud-configを生成し、kube クラウド設定はcloud.confキーに保存されます。すべてのクライアントは、生成された ConfigMap のみを使用することが期待されています。 - 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| キーを使用すると、設定マップ内の特定のキー/値を指すことができます。これは、論理ファイルの参照に役立ちます。 |
|
|
|
13.1.3. .spec.platformSpec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- platformSpec は、基盤となるインフラストラクチャープロバイダーに固有の必要な情報を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| alibabaCloud には、Alibaba Cloud インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| AWS には、アマゾンウェブサービスインフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Azure には、Azure インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| BareMetal には、BareMetal プラットフォームに固有の設定が含まれています。 |
|
|
| EquinixMetal には、EquinixMetal インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| GCP には、Google Cloud Platform インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| IBMCloud には、IBMCloud インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Kubevirt には、kubevirt インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Nutanix には、Nutanix インフラストラクチャープロバイダー固有の設定が含まれています。 |
|
|
| OpenStack には、OpenStack インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Ovirt には、oVirt インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| PowerVS には、IBM Power Systems Virtual Servers インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| type は、クラスターの基盤となるインフラストラクチャープロバイダーです。この値は、サービ出力ドバランサー、動的ボリュームプロビジョニング、マシンの作成と削除、およびその他の統合などのインフラストラクチャーの自動化を有効にするかどうかを制御します。None の場合、インフラストラクチャーの自動化は有効になりません。許可される値は、"AWS"、"Azure"、"BareMetal"、"GCP"、"Libvirt"、"OpenStack"、"VSphere"、"oVirt"、"KubeVirt"、"EquinixMetal"、"PowerVS"、"AlibabaCloud"、"Nutanix"、"None" です。個々のコンポーネントはすべてのプラットフォームをサポートしているわけではなく、認識されていないプラットフォームをサポートしていない場合は、そのプラットフォームをなしとして処理する必要があります。 |
|
|
| vSphere には、vSphere インフラストラクチャープロバイダーに固有の設定が含まれています。 |
13.1.4. .spec.platformSpec.alibabaCloud リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- alibabaCloud には、Alibaba Cloud インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.5. .spec.platformSpec.aws リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AWS には、アマゾンウェブサービスインフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| serviceEndpoints リストには、AWS サービスのデフォルトのサービスエンドポイントを上書きするカスタムエンドポイントが含まれています。サービスには ServiceEndpoint が 1 つだけ存在する必要があります。 |
|
|
| AWSServiceEndpoint は、カスタム URL の設定を保存して、AWS サービスの既存のデフォルトを上書きします。 |
13.1.6. .spec.platformSpec.aws.serviceEndpoints リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- serviceEndpoints リストには、AWS サービスのデフォルトのサービスエンドポイントを上書きするカスタムエンドポイントが含まれています。サービスには ServiceEndpoint が 1 つだけ存在する必要があります。
- 型
-
array
13.1.7. .spec.platformSpec.aws.serviceEndpoints[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AWSServiceEndpoint は、カスタム URL の設定を保存して、AWS サービスの既存のデフォルトを上書きします。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は AWS サービスの名前です。すべてのサービス名のリストは https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html にあります。これは提供する必要があり、空にすることはできません。 |
|
|
| url は、スキーム https を使用した完全修飾 URI であり、クライアント用にデフォルトで生成されたエンドポイントをオーバーライドします。これは提供する必要があり、空にすることはできません。 |
13.1.8. .spec.platformSpec.azure リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Azure には、Azure インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.9. .spec.platformSpec.baremetal リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- BareMetal には、BareMetal プラットフォームに固有の設定が含まれています。
- 型
-
object
13.1.10. .spec.platformSpec.equinixMetal リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- EquinixMetal には、Equinix Metal インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.11. .spec.platformSpec.gcp リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GCP には、Google Cloud Platform インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.12. .spec.platformSpec.ibmcloud リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- IBMCloud には、IBMCloud インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.13. .spec.platformSpec.kubevirt リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Kubevirt には、kubevirt インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.14. .spec.platformSpec.nutanix リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Nutanix には、Nutanix インフラストラクチャープロバイダー固有の設定が含まれています。
- 型
-
object - 必須
-
prismCentral -
prismElements
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| prismCentral は、Nutanix Prism Central にアクセスするためのエンドポイントアドレスとポートを保持します。クラスター全体のプロキシーがインストールされている場合、デフォルトでこのエンドポイントはプロキシー経由でアクセスされます。このエンドポイントとの通信をプロキシーしないようにする場合は、エンドポイントをプロキシーの spec.noProxy リストに追加してください。 |
|
|
| prismElements は、Nutanix Prism Central の Nutanix Prism Elements (クラスター) にアクセスするための 1 つ以上のエンドポイントアドレスとポートデータを保持します。現在、OpenShift クラスターで使用されるすべての Nutanix リソース (仮想マシン、サブネット、ボリュームなど) が配置される OpenShift クラスターでは、1 つの Prism Element (クラスター) のみをサポートしています。将来的には、Prism Central の複数の Prism Element (クラスター) に分散された Nutanix リソース (仮想マシンなど) をサポートする可能性があります。 |
|
|
| NutanixPrismElementEndpoint は、Prism Element (クラスター) の名前とエンドポイントデータを保持します。 |
13.1.15. .spec.platformSpec.nutanix.prismCentral リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- prismCentral は、Nutanix Prism Central にアクセスするためのエンドポイントアドレスとポートを保持します。クラスター全体のプロキシーがインストールされている場合、デフォルトでこのエンドポイントはプロキシー経由でアクセスされます。このエンドポイントとの通信をプロキシーしないようにする場合は、エンドポイントをプロキシーの spec.noProxy リストに追加してください。
- 型
-
object - 必須
-
address -
port
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| address は、Nutanix Prism Central または Element (クラスター) のエンドポイントアドレス (DNS 名または IP アドレス) です。 |
|
|
| port は Nutanix Prism Central または Element (クラスター) にアクセスするためのポート番号です。 |
13.1.16. .spec.platformSpec.nutanix.prismElements リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- prismElements は、Nutanix Prism Central の Nutanix Prism Elements (クラスター) にアクセスするための 1 つ以上のエンドポイントアドレスとポートデータを保持します。現在、OpenShift クラスターで使用されるすべての Nutanix リソース (仮想マシン、サブネット、ボリュームなど) が配置される OpenShift クラスターでは、1 つの Prism Element (クラスター) のみをサポートしています。将来的には、Prism Central の複数の Prism Element (クラスター) に分散された Nutanix リソース (仮想マシンなど) をサポートする可能性があります。
- 型
-
array
13.1.17. .spec.platformSpec.nutanix.prismElements[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- NutanixPrismElementEndpoint は、Prism Element (クラスター) の名前とエンドポイントデータを保持します。
- 型
-
object - 必須
-
endpoint -
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| endpoint は、Prism Element (クラスター) のエンドポイントアドレスとポートデータを保持します。クラスター全体のプロキシーがインストールされている場合、デフォルトでこのエンドポイントはプロキシー経由でアクセスされます。このエンドポイントとの通信をプロキシーしないようにする場合は、エンドポイントをプロキシーの spec.noProxy リストに追加してください。 |
|
|
| name は Prism Element (クラスター) の名前です。この値は、他のリソース (マシン、PVC など) で設定されたクラスターフィールドに対応します。 |
13.1.18. .spec.platformSpec.nutanix.prismElements[].endpoint リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- endpoint は、Prism Element (クラスター) のエンドポイントアドレスとポートデータを保持します。クラスター全体のプロキシーがインストールされている場合、デフォルトでこのエンドポイントはプロキシー経由でアクセスされます。このエンドポイントとの通信をプロキシーしないようにする場合は、エンドポイントをプロキシーの spec.noProxy リストに追加してください。
- 型
-
object - 必須
-
address -
port
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| address は、Nutanix Prism Central または Element (クラスター) のエンドポイントアドレス (DNS 名または IP アドレス) です。 |
|
|
| port は Nutanix Prism Central または Element (クラスター) にアクセスするためのポート番号です。 |
13.1.19. .spec.platformSpec.openstack リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OpenStack には、OpenStack インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.20. .spec.platformSpec.ovirt リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Ovirt には、oVirt インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.21. .spec.platformSpec.powervs リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PowerVS には、IBM Power Systems Virtual Servers インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| serviceEndpoints は、Power VS サービスのデフォルトのサービスエンドポイントをオーバーライドするカスタムエンドポイントのリストです。 |
|
|
| PowervsServiceEndpoint は、PowerVSServices の既存のデフォルトをオーバーライドするカスタム URL の設定を格納します。 |
13.1.22. .spec.platformSpec.powervs.serviceEndpoints リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- serviceEndpoints は、Power VS サービスのデフォルトのサービスエンドポイントをオーバーライドするカスタムエンドポイントのリストです。
- 型
-
array
13.1.23. .spec.platformSpec.powervs.serviceEndpoints[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PowervsServiceEndpoint は、PowerVSServices の既存のデフォルトをオーバーライドするカスタム URL の設定を格納します。
- 型
-
object - 必須
-
name -
url
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、Power VS サービスの名前です。IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud などのサービスがあります。 |
|
|
| url は、スキーム https を使用した完全修飾 URI であり、クライアント用にデフォルトで生成されたエンドポイントをオーバーライドします。これは提供する必要があり、空にすることはできません。 |
13.1.24. .spec.platformSpec.vsphere リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- vSphere には、vSphere インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
13.1.25. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalURL は、スキーム 'https'、アドレス、およびオプションでポート (デフォルトは 443) を持つ有効な URI です。apiServerInternalURL は、kubelets などのコンポーネントで使用でき、Kubernetes ネットワークではなくインフラストラクチャープロバイダーを使用して Kubernetes API サーバーに接続します。 |
|
|
| apiServerURL は、スキーム 'https'、アドレス、およびオプションでポート (デフォルトは 443) を持つ有効な URI です。apiServerURL は、Web コンソールなどのコンポーネントで使用して、Kubernetes API の場所をユーザーに通知できます。 |
|
|
| controlPlaneTopology は、通常は制御ノードで実行されるオペランドの期待値を表します。デフォルトは 'HighlyAvailable' です。これは、Operator が "通常" のクラスターで行う動作を表します。SingleReplica モードはシングルノードデプロイメントで使用され、Operator は高可用性操作のオペランドを設定しないでください。External モードは、コントロールプレーンがクラスターの外部でホストされ、そのコンポーネントが内部に表示されないことを示します。クラスター。 |
|
|
| etcdDiscoveryDomain は、etcd サーバーおよびクライアントを検出するために SRV レコードをフェッチするために使用されるドメインです。詳細: https://github.com/etcd-io/etcd/blob/329be66e8b3f9e2e6af83c123ff89297e49ebd15/Documentation/op-guide/clustering.md#dns-discovery 非推奨: 4.7 以降、このフィールドは設定または反映されなくなりました。これは今後のリリースで削除されます。 |
|
|
| infrastructureName は、人間にわかりやすい名前でクラスターを一意に識別します。一度設定すると、変更しないでください。最大長は 27 文字で、英数字またはハイフン文字のみを使用する必要があります。 |
|
|
|
infrastructureTopology は、コントロールプレーンノードで実行されないインフラストラクチャーサービスへの期待を表します。通常、 |
|
|
| プラットフォームは、クラスターの基盤となるインフラストラクチャープロバイダーです。非推奨: 代わりに platformStatus.type を使用してください。 |
|
|
| platformStatus は、基盤となるインフラストラクチャープロバイダーに固有のステータス情報を保持します。 |
13.1.26. .status.platformStatus リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- platformStatus は、基盤となるインフラストラクチャープロバイダーに固有のステータス情報を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| alibabaCloud には、Alibaba Cloud インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| AWS には、アマゾンウェブサービスインフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Azure には、Azure インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| BareMetal には、BareMetal プラットフォームに固有の設定が含まれています。 |
|
|
| EquinixMetal には、EquinixMetal インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| GCP には、Google Cloud Platform インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| IBMCloud には、IBMCloud インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Kubevirt には、kubevirt インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Nutanix には、Nutanix インフラストラクチャープロバイダー固有の設定が含まれています。 |
|
|
| OpenStack には、OpenStack インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| Ovirt には、oVirt インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| PowerVS には、Power Systems Virtual Servers インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
|
type は、クラスターの基盤となるインフラストラクチャープロバイダーです。この値は、サービ出力ドバランサー、動的ボリュームプロビジョニング、マシンの作成と削除、およびその他の統合などのインフラストラクチャーの自動化を有効にするかどうかを制御します。None の場合、インフラストラクチャーの自動化は有効になりません。許可される値は、"AWS"、"Azure"、"BareMetal"、"GCP"、"Libvirt"、"OpenStack"、"VSphere"、"oVirt"、"EquinixMetal"、"PowerVS"、"AlibabaCloud"、"Nutanix"、"None" です。個々のコンポーネントはすべてのプラットフォームをサポートしているわけではなく、認識されていないプラットフォームをサポートしていない場合は、そのプラットフォームをなしとして処理する必要があります。この値は、 |
|
|
| vSphere には、vSphere インフラストラクチャープロバイダーに固有の設定が含まれています。 |
13.1.27. .status.platformStatus.alibabaCloud リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- alibabaCloud には、Alibaba Cloud インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object - 必須
-
region
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| region は、クラスター用に作成された Alibaba Cloud リソースのリージョンを指定します。 |
|
|
| resourceGroupID は、クラスターのリソースグループの ID です。 |
|
|
| resourceTags は、クラスター用に作成された Alibaba Cloud リソースに適用する追加のタグのリストです。 |
|
|
| AlibabaCloudResourceTag は、リソースに適用するために追加するタグのセットです。 |
13.1.28. .status.platformStatus.alibabaCloud.resourceTags リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- resourceTags は、クラスター用に作成された Alibaba Cloud リソースに適用する追加のタグのリストです。
- 型
-
array
13.1.29. .status.platformStatus.alibabaCloud.resourceTags[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AlibabaCloudResourceTag は、リソースに適用するために追加するタグのセットです。
- 型
-
object - 必須
-
key -
value
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key はタグのキーです。 |
|
|
| value はタグの値です。 |
13.1.30. .status.platformStatus.aws リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AWS には、アマゾンウェブサービスインフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| region は、クラスターによって作成された新しい AWS リソースのデフォルトの AWS リージョンを保持します。 |
|
|
| resourceTags は、クラスター用に作成された AWS リソースに適用する追加のタグのリストです。AWS リソースのタグ付けについては、https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html を参照してください。AWS は、リソースごとに最大 50 個のタグをサポートします。OpenShift は、使用するために 25 個のタグを予約し、ユーザーが 25 個のタグを使用できるようにします。 |
|
|
| AWSResourceTag は、クラスター用に作成された AWS リソースに適用するタグです。 |
|
|
| ServiceEndpoints リストには、AWS サービスのデフォルトのサービスエンドポイントを上書きするカスタムエンドポイントが含まれています。サービスには ServiceEndpoint が 1 つだけ存在する必要があります。 |
|
|
| AWSServiceEndpoint は、カスタム URL の設定を保存して、AWS サービスの既存のデフォルトを上書きします。 |
13.1.31. .status.platformStatus.aws.resourceTags リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- resourceTags は、クラスター用に作成された AWS リソースに適用する追加のタグのリストです。AWS リソースのタグ付けについては、https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html を参照してください。AWS は、リソースごとに最大 50 個のタグをサポートします。OpenShift は、使用するために 25 個のタグを予約し、ユーザーが 25 個のタグを使用できるようにします。
- 型
-
array
13.1.32. .status.platformStatus.aws.resourceTags[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AWSResourceTag は、クラスター用に作成された AWS リソースに適用するタグです。
- 型
-
object - 必須
-
key -
value
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key はタグのキーです |
|
|
| value はタグの値です。一部の AWS サービスは空の値をサポートしていません。タグは多くのサービスのリソースに追加されるため、タグ値の長さはすべてのサービスの要件を満たす必要があります。 |
13.1.33. .status.platformStatus.aws.serviceEndpoints リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ServiceEndpoints リストには、AWS サービスのデフォルトのサービスエンドポイントを上書きするカスタムエンドポイントが含まれています。サービスには ServiceEndpoint が 1 つだけ存在する必要があります。
- 型
-
array
13.1.34. .status.platformStatus.aws.serviceEndpoints[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- AWSServiceEndpoint は、カスタム URL の設定を保存して、AWS サービスの既存のデフォルトを上書きします。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は AWS サービスの名前です。すべてのサービス名のリストは https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html にあります。これは提供する必要があり、空にすることはできません。 |
|
|
| url は、スキーム https を使用した完全修飾 URI であり、クライアント用にデフォルトで生成されたエンドポイントをオーバーライドします。これは提供する必要があり、空にすることはできません。 |
13.1.35. .status.platformStatus.azure リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Azure には、Azure インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| armEndpoint は、Azure Stack などの非ソブリンクラウドでのリソース管理に使用する URL を指定します。 |
|
|
|
cloudName は、適切な Azure API エンドポイントで Azure SDK を設定するために使用できる Azure クラウド環境の名前。空の場合、値は |
|
|
| networkResourceGroupName は、クラスターで使用される仮想ネットワークやサブネットなどのネットワークリソースのリソースグループです。空の場合、値は ResourceGroupName と同じです。 |
|
|
| resourceGroupName は、クラスター用に作成された新しい Azure リソースのリソースグループです。 |
13.1.36. .status.platformStatus.baremetal リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- BareMetal には、BareMetal プラットフォームに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。非推奨: 代わりに APIServerInternalIPs を使用します。 |
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets をはじめとする、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。これらは、API サーバーの前にあるセルフホスト型ロードバランサーの IP です。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。非推奨: 代わりに IngressIP を使用します。 |
|
|
| ingressIP は、デフォルトの ingress コントローラーにルーティングされる外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
|
nodeDNSIP は、ノードが使用する内部 DNS の IP アドレスです。DNS Operator によって管理されるものとは異なり、 |
13.1.37. .status.platformStatus.equinixMetal リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- EquinixMetal には、Equinix Metal インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。 |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。 |
13.1.38. .status.platformStatus.gcp リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- GCP には、Google Cloud Platform インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| resourceGroupName は、クラスター用に作成された新しい GCP リソースのプロジェクト ID です。 |
|
|
| region は、クラスター用に作成された新しい GCP リソースのリージョンを保持します。 |
13.1.39. .status.platformStatus.ibmcloud リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- IBMCloud には、IBMCloud インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| CISInstanceCRN は、クラスターのベースドメインの DNS ゾーンを管理するクラウドインターネットサービスインスタンスの CRN です。 |
|
|
| DNSInstanceCRN は、クラスターのベースドメインの DNS ゾーンを管理する DNS サービスインスタンスの CRN です。 |
|
|
| 場所は、クラスターがデプロイされた場所です |
|
|
| ProviderType は、作成されたクラスターのタイプを示します |
|
|
| ResourceGroupName は、クラスター用に作成された新しい IBMCloud リソースのリソースグループです。 |
13.1.40. .status.platformStatus.kubevirt リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Kubevirt には、kubevirt インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。 |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。 |
13.1.41. .status.platformStatus.nutanix リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Nutanix には、Nutanix インフラストラクチャープロバイダー固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。非推奨: 代わりに APIServerInternalIPs を使用します。 |
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets をはじめとする、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。これらは、API サーバーの前にあるセルフホスト型ロードバランサーの IP です。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。非推奨: 代わりに IngressIP を使用します。 |
|
|
| ingressIP は、デフォルトの ingress コントローラーにルーティングされる外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
13.1.42. .status.platformStatus.openstack リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OpenStack には、OpenStack インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。非推奨: 代わりに APIServerInternalIPs を使用します。 |
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets をはじめとする、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。これらは、API サーバーの前にあるセルフホスト型ロードバランサーの IP です。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
|
cloudName は、クライアント設定ファイル ( |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。非推奨: 代わりに IngressIP を使用します。 |
|
|
| ingressIP は、デフォルトの ingress コントローラーにルーティングされる外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
|
nodeDNSIP は、ノードが使用する内部 DNS の IP アドレスです。DNS Operator によって管理されるものとは異なり、 |
13.1.43. .status.platformStatus.ovirt リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Ovirt には、oVirt インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。非推奨: 代わりに APIServerInternalIPs を使用します。 |
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets をはじめとする、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。これらは、API サーバーの前にあるセルフホスト型ロードバランサーの IP です。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。非推奨: 代わりに IngressIP を使用します。 |
|
|
| ingressIP は、デフォルトの ingress コントローラーにルーティングされる外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
| 非推奨:4.6 以降、このフィールドは設定または適用されなくなりました。これは今後のリリースで削除されます。 |
13.1.44. .status.platformStatus.powervs リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PowerVS には、Power Systems Virtual Servers インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| CISInstanceCRN は、クラスターのベースドメインの DNS ゾーンを管理するクラウドインターネットサービスインスタンスの CRN です。 |
|
|
| DNSInstanceCRN は、クラスターのベースドメインの DNS ゾーンを管理する DNS サービスインスタンスの CRN です。 |
|
|
| region は、クラスターによって作成された新しい PowerVS リソースのデフォルトの PowerVS リージョンを保持します。 |
|
|
| serviceEndpoints は、Power VS サービスのデフォルトのサービスエンドポイントをオーバーライドするカスタムエンドポイントのリストです。 |
|
|
| PowervsServiceEndpoint は、PowerVSServices の既存のデフォルトをオーバーライドするカスタム URL の設定を格納します。 |
|
|
| zone は、クラスターによって作成された新しい Power VS リソースのデフォルトゾーンを保持します。注: 現在、シングルゾーン OCP クラスターのみがサポートされています |
13.1.45. .status.platformStatus.powervs.serviceEndpoints リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- serviceEndpoints は、Power VS サービスのデフォルトのサービスエンドポイントをオーバーライドするカスタムエンドポイントのリストです。
- 型
-
array
13.1.46. .status.platformStatus.powervs.serviceEndpoints[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- PowervsServiceEndpoint は、PowerVSServices の既存のデフォルトをオーバーライドするカスタム URL の設定を格納します。
- 型
-
object - 必須
-
name -
url
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、Power VS サービスの名前です。IAM - https://cloud.ibm.com/apidocs/iam-identity-token-api ResourceController - https://cloud.ibm.com/apidocs/resource-controller/resource-controller Power Cloud - https://cloud.ibm.com/apidocs/power-cloud などのサービスがあります。 |
|
|
| url は、スキーム https を使用した完全修飾 URI であり、クライアント用にデフォルトで生成されたエンドポイントをオーバーライドします。これは提供する必要があり、空にすることはできません。 |
13.1.47. .status.platformStatus.vsphere リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- vSphere には、vSphere インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets など、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。Infrastructure.status.apiServerInternalURI が指す IP です。これは、API サーバーの前にある自己ホスト型ロードバランサーの IP です。非推奨: 代わりに APIServerInternalIPs を使用します。 |
|
|
| apiServerInternalIP は、Kubernetes ネットワークではなくインフラストラクチャーを使用する kubelets をはじめとする、クラスター内のコンポーネントで使用できる Kubernetes API サーバーに接続するための IP アドレスです。これらは、API サーバーの前にあるセルフホスト型ロードバランサーの IP です。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
| ingressIP は、デフォルトの入力コントローラーにルーティングする外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。非推奨: 代わりに IngressIP を使用します。 |
|
|
| ingressIP は、デフォルトの ingress コントローラーにルーティングされる外部 IP です。IP は、デフォルトルートのホスト名を解決するために使用されるワイルドカード DNS レコードの適切なターゲットです。デュアルスタッククラスターの場合、このリストには 2 つの IP が含まれますが、それ以外では 1 つの IP のみが含まれます。 |
|
|
|
nodeDNSIP は、ノードが使用する内部 DNS の IP アドレスです。DNS Operator によって管理されるものとは異なり、 |
13.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/infrastructures-
削除: インフラストラクチャーのコレクションを削除します -
GET: インフラストラクチャーの種類のオブジェクトをリスト表示します -
POST: インフラストラクチャーを作成する
-
/apis/config.openshift.io/v1/infrastructures/{name}-
削除: インフラストラクチャーを削除します -
GET: 指定されたインフラストラクチャーを読み取ります -
PATCH: 指定されたインフラストラクチャーを部分的に更新します -
PUT: 指定されたインフラストラクチャーを置き換えます
-
/apis/config.openshift.io/v1/infrastructures/{name}/status-
GET: 指定されたインフラストラクチャーのステータスを読み取ります -
PATCH: 指定されたインフラストラクチャーのステータスを部分的に更新します -
PUT: 指定されたインフラストラクチャーのステータスを置き換えます
-
13.2.1. /apis/config.openshift.io/v1/infrastructures リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- インフラストラクチャーのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- インフラストラクチャーの種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- インフラストラクチャーを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
13.2.2. /apis/config.openshift.io/v1/infrastructures/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| インフラストラクチャーの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- インフラストラクチャーを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたインフラストラクチャーを読む
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたインフラストラクチャーを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたインフラストラクチャーを交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
13.2.3. /apis/config.openshift.io/v1/infrastructures/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| インフラストラクチャーの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定されたインフラストラクチャーのステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたインフラストラクチャーのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたインフラストラクチャーのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第14章 Ingress [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
Ingress は、ルートに使用されるデフォルトの入力ドメインを含む、入力に関するクラスター全体の情報を保持します。正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object - 必須
-
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 を参照してください。 | |
|
|
| spec は、ユーザーが設定可能な設定値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
14.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| appsDomain は、明示的なホストを指定せずにルートを作成するときに、ドメインフィールドで指定されたドメインの代わりに使用するオプションのドメインです。appsDomain が空でない場合、この値は Route のデフォルトのホスト値を生成するために使用されます。ドメインとは異なり、appsDomain はインストール後に変更される場合があります。これは、新しい ingresscontroller がワイルドカード証明書を使用してセットアップされていることを前提としています。 |
|
|
| componentRoutes は、クラスター管理者がホスト名とサービング証明書を設定できる OpenShift コンポーネントによって管理されるルートのオプションのリストです。このリストの各ルートの名前空間と名前は、status.componentRoutes リストの既存のエントリーと一致する必要があります。設定可能なルートのセットを判別するには、.status.componentRoutes リストの名前空間とエントリーの名前を確認します。ここで、参加している Operator が設定可能なルートのステータスを書き込みます。 |
|
|
| ComponentRouteSpec を使用すると、ルートのホスト名とサービング証明書を設定できます。 |
|
|
| ドメインは、ルートのホスト名が空の場合に、ルートのデフォルトのホスト名を生成するために使用されます。生成されたホスト名は、"<route-name>.<route-namespace>.<domain>" のパターンに従います。これは、入力のデフォルトのワイルドカードドメイン接尾辞としても使用されます。デフォルトの ingresscontroller ドメインは、"*.<domain>" のパターンに従います。一度設定すると、ドメインの変更は現在サポートされていません。 |
|
|
| loadBalancer には、現在のクラスターの基盤となるインフラストラクチャープロバイダーに固有のものだけではなく、Ingress Controller が OpenShift 上で動作するために必要となる、一般的なロードバランサーの詳細が含まれています。 |
|
|
| requiredHSTSPolicies は、ポリシーで指定された domainPattern/s および namespaceSelector/s に一致する新しく作成または更新されたルートに設定する必要がある HSTS ポリシーを指定します。各 requiredHSTSPolicy には、ルート HSTS ポリシールートアノテーションを検証し、ルートアドミッションに影響を与えるために、少なくとも domainPattern と maxAge が必要です。HSTS ポリシールートアノテーションが付いている場合、候補ルートは HSTS ポリシーについてチェックされます: "haproxy.router.openshift.io/hsts_header" 例:haproxy.router.openshift.io/hsts_header:max-age = 31536000; preload; includeSubDomains-For 各候補ルートは、requiredHSTSPolicy domainPattern およびオプションの namespaceSelector と一致する場合、maxAge、preloadPolicy、および includeSubdomainsPolicy が許可されるために有効である必要があります。それ以外の場合、ルートは拒否されます。- domainPattern およびオプションの namespaceSelector による、RequiredHSTSPolicies の順序での最初の一致により、ルートのアドミッションステータスが決まります。- 候補ルートが requiredHSTSPolicy の domainPattern およびオプションの namespaceSelector と一致しない場合、HSTS ポリシーアノテーションを使用できます。HSTS ポリシー設定は、ルートがすでに作成された後で変更される場合があります。更新されたルートが更新された HSTS ポリシー設定に準拠していない場合、以前に許可されたルートへの更新は失敗する可能性があります。ただし、HSTS ポリシー設定を変更しても、すでに許可されているルートが機能しなくなることはありません。RequiredHSTSPolicies がない場合、ルート上のすべての HSTS ポリシーアノテーションが有効であることに注意してください。 |
|
|
|
14.1.2. .spec.componentRoutes リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- componentRoutes は、クラスター管理者がホスト名とサービング証明書を設定できる OpenShift コンポーネントによって管理されるルートのオプションのリストです。このリストの各ルートの名前空間と名前は、status.componentRoutes リストの既存のエントリーと一致する必要があります。設定可能なルートのセットを判別するには、.status.componentRoutes リストの名前空間とエントリーの名前を確認します。ここで、参加している Operator が設定可能なルートのステータスを書き込みます。
- 型
-
array
14.1.3. .spec.componentRoutes[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ComponentRouteSpec を使用すると、ルートのホスト名とサービング証明書を設定できます。
- 型
-
object - 必須
-
hostname -
name -
namespace
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| hostname は、ルートで使用されるホスト名です。 |
|
|
| name は、カスタマイズするルートの論理名です。ルートをカスタマイズする場合は、この componentRoute の名前空間と名前が status.componentRoutes のリストの対応するエントリーと一致する必要があります。 |
|
|
| namespace は、カスタマイズするルートの名前空間です。ルートをカスタマイズする場合は、この componentRoute の名前空間と名前が status.componentRoutes のリストの対応するエントリーと一致する必要があります。 |
|
|
|
servingCertKeyPairSecret は、openshift-config 名前空間のタイプ |
14.1.4. .spec.componentRoutes[].servingCertKeyPairSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
servingCertKeyPairSecret は、openshift-config 名前空間のタイプ
kubernetes.io/tlsのシークレットへの参照です。サービング証明書/キーのペアは一致する必要があり、この名前でサービングする目的を果たすために Operator によって使用されます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。 - 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
14.1.5. .spec.loadBalancer リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- loadBalancer には、現在のクラスターの基盤となるインフラストラクチャープロバイダーに固有のものだけではなく、Ingress Controller が OpenShift 上で動作するために必要となる、一般的なロードバランサーの詳細が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| platform は、Ingress ロードバランサーの基盤となるインフラストラクチャープロバイダーに固有の設定を保持します。これを省略した場合、ユーザーには選択する意図がないことを意味し、プラットフォームが適切なデフォルトを選択します。これらのデフォルトは時間の経過とともに変更される可能性があります。 |
14.1.6. .spec.loadBalancer.platform リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- platform は、Ingress ロードバランサーの基盤となるインフラストラクチャープロバイダーに固有の設定を保持します。これを省略した場合、ユーザーには選択する意図がないことを意味し、プラットフォームが適切なデフォルトを選択します。これらのデフォルトは時間の経過とともに変更される可能性があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| aws には、Amazon Web Services インフラストラクチャープロバイダーに固有の設定が含まれています。 |
|
|
| type は、クラスターの基盤となるインフラストラクチャープロバイダーです。許可される値は、"AWS"、"Azure"、"BareMetal"、"GCP"、"Libvirt"、"OpenStack"、"VSphere"、"oVirt"、"KubeVirt"、"EquinixMetal"、"PowerVS"、"AlibabaCloud"、"Nutanix"、"None" です。個々のコンポーネントはすべてのプラットフォームをサポートしているわけではなく、認識されていないプラットフォームをサポートしていない場合は、そのプラットフォームをなしとして処理する必要があります。 |
14.1.7. .spec.loadBalancer.platform.aws リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- aws には、Amazon Web Services インフラストラクチャープロバイダーに固有の設定が含まれています。
- 型
-
object - 必須
-
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| type を使用すると、ユーザーはロードバランサーのタイプを設定できます。このフィールドが設定されている場合、指定された LBType を使用してデフォルトの ingresscontroller が作成されます。このフィールドが設定されていない場合、LBType Classic のデフォルトの ingress controller が作成されます。有効な値は次のとおりです。*"Classic": トランスポート層 (TCP/SSL) またはアプリケーション層 (HTTP/HTTPS) のいずれかでルーティングを決定するクラシックロードバランサー。詳細は、以下を参照して ください。https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#clb * "NLB": トランスポートでルーティングを決定するネットワークロードバランサーレイヤー (TCP/SSL)。詳細は、https://docs.aws.amazon.com/AmazonECS/latest/developerguide/load-balancer-types.html#nlb を参照してください。 |
14.1.8. .spec.requiredHSTSPolicies リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- requiredHSTSPolicies は、ポリシーで指定された domainPattern/s および namespaceSelector/s に一致する新しく作成または更新されたルートに設定する必要がある HSTS ポリシーを指定します。各 requiredHSTSPolicy には、ルート HSTS ポリシールートアノテーションを検証し、ルートアドミッションに影響を与えるために、少なくとも domainPattern と maxAge が必要です。HSTS ポリシールートアノテーションが付いている場合、候補ルートは HSTS ポリシーについてチェックされます: "haproxy.router.openshift.io/hsts_header" 例:haproxy.router.openshift.io/hsts_header:max-age = 31536000; preload; includeSubDomains-For 各候補ルートは、requiredHSTSPolicy domainPattern およびオプションの namespaceSelector と一致する場合、maxAge、preloadPolicy、および includeSubdomainsPolicy が許可されるために有効である必要があります。それ以外の場合、ルートは拒否されます。- domainPattern およびオプションの namespaceSelector による、RequiredHSTSPolicies の順序での最初の一致により、ルートのアドミッションステータスが決まります。- 候補ルートが requiredHSTSPolicy の domainPattern およびオプションの namespaceSelector と一致しない場合、HSTS ポリシーアノテーションを使用できます。HSTS ポリシー設定は、ルートがすでに作成された後で変更される場合があります。更新されたルートが更新された HSTS ポリシー設定に準拠していない場合、以前に許可されたルートへの更新は失敗する可能性があります。ただし、HSTS ポリシー設定を変更しても、すでに許可されているルートが機能しなくなることはありません。RequiredHSTSPolicies がない場合、ルート上のすべての HSTS ポリシーアノテーションが有効であることに注意してください。
- 型
-
array
14.1.9. .spec.requiredHSTSPolicies[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 型
-
object - 必須
-
domainPatterns
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| domainPatterns は、必要な HSTS アノテーションが必要なドメインのリストです。domainPatterns が指定され、ドメインの 1 つと一致する spec.host を使用してルートが作成される場合、ルートは、一致する RequiredHSTSPolicy で説明されている HSTS ポリシーコンポーネントを指定する必要があります。ワイルドカードの使用は次のように許可され ます。.foo.com は foo.com の下のすべてに一致します。foo.com は foo.com とのみ一致するため、foo.com とその下のすべてをカバーするには、*both を指定する必要があります。 |
|
|
| includeSubDomainsPolicy は、HSTS ポリシーがホストのドメイン名のすべてのサブドメインに適用される必要があることを意味します。したがって、ホスト bar.foo.com の場合、includeSubDomainsPolicy が RequireIncludeSubDomains に設定されていると、次のようになります。- ホスト app.bar.foo.com は bar.foo.com の HSTS ポリシーを継承します - ホスト bar.foo.com は bar.foo.com の HSTS ポリシー - ホスト foo.com は bar.foo.com の HSTS ポリシーを継承しません - ホスト def.foo.com は bar.foo.com の HSTS ポリシーを継承しません |
|
|
| maxAge は、ホストが HSTS ホストと見なされる秒単位のデルタ時間範囲です。0 に設定すると、効果が無効になり、ホストは HSTS ホストとして削除されます。0 に設定し、includeSubdomains を指定すると、ホストのすべてのサブドメインも HSTS ホストとして削除されます。maxAge は存続時間の値であり、このポリシーがクライアントで更新されない場合、HSTS ポリシーは最終的にそのクライアントで期限切れになります。 |
|
|
| namespaceSelector は、ポリシーがセレクターと一致するラベルを持つ名前空間にあり、DomainPatterns の 1 つにあるルートにのみ適用されるようにラベルセレクターを指定します。デフォルトは空の LabelSelector で、すべてに一致します。 |
|
|
| preloadPolicy は、HSTS ヘッダーを取得するために初期ロードを実行する必要がないように、ホストをホストプリロードリストに含めるようにクライアントに指示します (これは RFC 6797 で定義されていないため、クライアントの実装に依存します)。 |
14.1.10. .spec.requiredHSTSPolicies[].maxAge リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- maxAge は、ホストが HSTS ホストと見なされる秒単位のデルタ時間範囲です。0 に設定すると、効果が無効になり、ホストは HSTS ホストとして削除されます。0 に設定し、includeSubdomains を指定すると、ホストのすべてのサブドメインも HSTS ホストとして削除されます。maxAge は存続時間の値であり、このポリシーがクライアントで更新されない場合、HSTS ポリシーは最終的にそのクライアントで期限切れになります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| RequiredHSTSPolicy max-age の最大許容値 (秒単位) この値は指定しないでおくことができます。その場合、上限は適用されません。 |
|
|
| RequiredHSTSPolicy max-age の最小許容値 (秒単位)max-age = 0 を設定すると、ホストから既存の HSTS ヘッダーを削除できます。これは、管理者が間違いをすばやく修正するために必要なツールです。この値は指定しないでおくことができます。その場合、下限は適用されません。 |
14.1.11. .spec.requiredHSTSPolicies[].namespaceSelector リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- namespaceSelector は、ポリシーがセレクターと一致するラベルを持つ名前空間にあり、DomainPatterns の 1 つにあるルートにのみ適用されるようにラベルセレクターを指定します。デフォルトは空の LabelSelector で、すべてに一致します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
14.1.12. .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。
- 型
-
array
14.1.13. .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object - 必須
-
key -
operator
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
14.1.14. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| componentRoutes は、参加している Operator が、クラスター管理者がホスト名とサービング証明書をカスタマイズできるルートの現在のルートステータスを配置する場所です。 |
|
|
| ComponentRouteStatus には、ルートのホスト名とサービング証明書の設定を可能にする情報が含まれています。 |
|
|
| defaultPlacement はインストール時に設定され、デフォルトで Ingress ルーター Pod をホストするノードを制御します。オプションは、コントロールプレーンノードまたはワーカーノードです。このフィールドは、対応するデプロイメントの作成時に、Cluster Ingress Operator が IngressController リソース内の未設定のレプリカと nodePlacement フィールドをどのように考慮するかを指示します。詳細は、IngressController レプリカおよび nodePlacement フィールドのドキュメントを参照してください。省略した場合、デフォルト値は Workers です。 |
14.1.15. .status.componentRoutes リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- componentRoutes は、参加している Operator が、クラスター管理者がホスト名とサービング証明書をカスタマイズできるルートの現在のルートステータスを配置する場所です。
- 型
-
array
14.1.16. .status.componentRoutes[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ComponentRouteStatus には、ルートのホスト名とサービング証明書の設定を可能にする情報が含まれています。
- 型
-
object - 必須
-
defaultHostname -
name -
namespace -
relatedObjects
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 条件は、componentRoutes エントリーの状態を伝達するために使用されます。サポートされている条件には、Available、Degraded、および Progressing が含まれます。利用可能が true の場合、ルートによって提供されるコンテンツにユーザーがアクセスできます。これには、cluster-admin によって指定されたカスタマイズされたルートが設定されている間、デフォルトがコンテンツを提供し続ける場合が含まれます。Degraded が true の場合、componentRoutes エントリーを処理しようとして問題が発生したことを意味します。currentHostnames フィールドは、有効な場合と無効な場合があります。Progressing が true の場合、コンポーネントが componentRoutes エントリーに関連するアクションを実行していることを意味します。 |
|
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition |
|
|
| consumingUsers は、servingCertKeyPairSecret シークレットの読み取り権限が必要な ServiceAccounts のスライスです。 |
|
|
| currentHostnames は、ルートで使用されている現在の名前のリストです。通常、このリストは単一のホスト名で構成されている必要がありますが、ルートで複数のホスト名がサポートされている場合、Operator はこのリストに複数のエントリーを書き込むことができます。 |
|
|
| defaultHostname は、カスタマイズ前のこのルートのホスト名です。 |
|
|
| name は、カスタマイズするルートの論理名です。ルートリソースの実際の名前である必要はありませんが、名前を変更することはできません。ルートをカスタマイズする場合、この componentRoute の名前空間と名前は、spec.componentRoutes のリスト内の対応するエントリーと一致する必要があります。 |
|
|
| namespace は、カスタマイズするルートの名前空間です。実際の名前空間である必要があります。実際の名前空間を使用すると、2 つのコンポーネントが競合することはなく、同じコンポーネントを複数回インストールできます。ルートをカスタマイズする場合、この componentRoute の名前空間と名前は、spec.componentRoutes のリスト内の対応するエントリーと一致する必要があります。 |
|
|
| relatedObjects は、spec.componentRoutes がどのように適用されるかをデバッグまたは検査するときに役立つリソースのリストです。 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
14.1.17. .status.componentRoutes[].conditions リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 条件は、componentRoutes エントリーの状態を伝達するために使用されます。サポートされている条件には、Available、Degraded、および Progressing が含まれます。利用可能が true の場合、ルートによって提供されるコンテンツにユーザーがアクセスできます。これには、cluster-admin によって指定されたカスタマイズされたルートが設定されている間、デフォルトがコンテンツを提供し続ける場合が含まれます。Degraded が true の場合、componentRoutes エントリーを処理しようとして問題が発生したことを意味します。currentHostnames フィールドは、有効な場合と無効な場合があります。Progressing が true の場合、コンポーネントが componentRoutes エントリーに関連するアクションを実行していることを意味します。
- 型
-
array
14.1.18. .status.componentRoutes[].conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"// other fields } - 型
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
14.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/ingresses-
DELETE: 入力のコレクションを削除します -
GET:Ingress の種類のオブジェクトをリスト表示します -
POST: 入力を作成します
-
/apis/config.openshift.io/v1/ingresses/{name}-
削除: 入力を削除します -
GET: 指定された入力を読み取ります -
PATCH: 指定された入力を部分的に更新します -
PUT: 指定された入力を置き換えます
-
/apis/config.openshift.io/v1/ingresses/{name}/status-
GET: 指定された入力のステータスを読み取ります -
PATCH: 指定された入力のステータスを部分的に更新します -
PUT: 指定された入力のステータスを置き換えます
-
14.2.1. /apis/config.openshift.io/v1/ingresses リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- Ingress のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- Ingress の種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- イングレスを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
14.2.2. /apis/config.openshift.io/v1/ingresses/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イングレスの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- 入力を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された入力を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された入力を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された入力を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
14.2.3. /apis/config.openshift.io/v1/ingresses/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イングレスの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された入力のステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された入力のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された入力のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第15章 Network [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
ネットワークは、ネットワークに関するクラスター全体の情報を保持します。正規名は
clusterです。これは、サービス/Pod IP の IP アドレスプール、ネットワークプラグインなどの目的のネットワーク設定を設定するために使用されます。このリソースを設定するときに適用される内容の説明は、network.spec を参照してください。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object - 必須
-
spec
-
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 設定でユーザーが設定できる値を保持します。原則として、これを直接読み取るべきではありません。代わりに、現在デプロイメントされている設定を示すため、NetworkStatus を使用する必要があります。現在、ほとんどのスペックフィールドはインストール後に不変です。各詳細はそれぞれ参照してください。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
15.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec 設定でユーザーが設定できる値を保持します。原則として、これを直接読み取るべきではありません。代わりに、現在デプロイメントされている設定を示すため、NetworkStatus を使用する必要があります。現在、ほとんどのスペックフィールドはインストール後に不変です。各詳細はそれぞれ参照してください。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Pod IP に使用する IP アドレスプール。このフィールドは、インストール後は不変です。 |
|
|
| clusterNetworkEntry は、Pod IP が割り当てられる IP アドレスの連続したブロックです。 |
|
|
| externalIP は、Service.ExternalIP に影響を与えるコントローラーの設定を定義します。nil の場合、ExternalIP を設定することはできません。 |
|
|
| NetworkType は、デプロイされるプラグインです (OpenShiftSDN など)。これは、cluster-network-operator が理解できる値と一致する必要があります。一致しない場合、ネットワークはインストールされません。現在サポートされている値は次のとおりです。-OpenShiftSDN このフィールドは、インストール後は不変です。 |
|
|
| サービスの IP アドレスプール。現在、ここでは 1 つのエントリーのみをサポートしています。このフィールドは、インストール後は不変です。 |
|
|
| NodePort タイプのサービスに許可されるポート範囲。指定しない場合、デフォルトの 30000-32767 が使用されます。NodePort が指定されていないこのようなサービスでは、この範囲から自動的に割り当てられます。このパラメーターは、クラスターのインストール後に更新できます。 |
15.1.2. .spec.clusterNetwork リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod IP に使用する IP アドレスプール。このフィールドは、インストール後は不変です。
- 型
-
array
15.1.3. .spec.clusterNetwork[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clusterNetworkEntry は、Pod IP が割り当てられる IP アドレスの連続したブロックです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Pod IP の完全なブロック。 |
|
|
| 各ノードに割り当てるブロックのサイズ (接頭辞)。このフィールドがプラグインで使用されていない場合は、未設定のままにしておくことができます。 |
15.1.4. .spec.externalIP リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- externalIP は、Service.ExternalIP に影響を与えるコントローラーの設定を定義します。nil の場合、ExternalIP を設定することはできません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| autoAssignCIDRs は、Service.ExternalIP を自動的に割り当てる CIDR のリストです。これらは、サービスのタイプが LoadBalancer の場合に割り当てられます。一般に、これはベアメタルクラスターにのみ役立ちます。OpenShift 3.x では、これは誤解を招くように "IngressIPs" と呼ばれていました。自動的に割り当てられた外部 IP は、ExternalIPPolicy ルールの影響を受けません。現在、提供できるエントリーは 1 つだけです。 |
|
|
| ポリシーは、ExternalIP フィールドに適用される一連の制限です。nil または空の場合、ExternalIP を設定することはできません。 |
15.1.5. .spec.externalIP.policy リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ポリシーは、ExternalIP フィールドに適用される一連の制限です。nil または空の場合、ExternalIP を設定することはできません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| allowedCIDRs は、許可された CIDR のリストです。 |
|
|
| rejectedCIDRs は、許可されていない CIDR のリストです。これらは、allowedCIDR よりも優先されます。 |
15.1.6. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Pod IP に使用する IP アドレスプール。 |
|
|
| clusterNetworkEntry は、Pod IP が割り当てられる IP アドレスの連続したブロックです。 |
|
|
| ClusterNetworkMTU は、Pod 間ネットワーク用の MTU です。 |
|
|
| 移行には、クラスターネットワークの移行設定が含まれます。 |
|
|
| NetworkType は、デプロイされるプラグインです (OpenShiftSDN など)。 |
|
|
| サービスの IP アドレスプール。現在、ここでは 1 つのエントリーのみをサポートしています。 |
15.1.7. .status.clusterNetwork リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Pod IP に使用する IP アドレスプール。
- 型
-
array
15.1.8. .status.clusterNetwork[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clusterNetworkEntry は、Pod IP が割り当てられる IP アドレスの連続したブロックです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Pod IP の完全なブロック。 |
|
|
| 各ノードに割り当てるブロックのサイズ (接頭辞)。このフィールドがプラグインで使用されていない場合は、未設定のままにしておくことができます。 |
15.1.9. .status.migration リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 移行には、クラスターネットワークの移行設定が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| mtu には、MTU 移行設定を含めます。 |
|
|
| NetworkType は、デプロイされるターゲットプラグインです。現在サポートされている値は次のとおりです。OpenShiftSDN、OVNKubernetes |
15.1.10. .status.migration.mtu リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- mtu には、MTU 移行設定を含めます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| machine には、マシンのアップリンクの MTU 移行設定が含まれています。 |
|
|
| network には、デフォルトネットワークの MTU 移行設定が含まれています。 |
15.1.11. .status.migration.mtu.machine リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- machine には、マシンのアップリンクの MTU 移行設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| from は移行元の MTU です。 |
|
|
| to は移行先の MTU です。 |
15.1.12. .status.migration.mtu.network リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- network には、デフォルトネットワークの MTU 移行設定が含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| from は移行元の MTU です。 |
|
|
| to は移行先の MTU です。 |
15.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/networks-
削除: ネットワークのコレクションを削除します -
GET: 種類が Network のオブジェクトをリスト表示します。 -
POST: ネットワークを作成する
-
/apis/config.openshift.io/v1/networks/{name}-
削除: ネットワークを削除します -
GET: 指定された Network を読み取ります。 -
PATCH: 指定された Network を部分的に更新します。 -
PUT: 指定されたネットワークを置き換えます
-
15.2.1. /apis/config.openshift.io/v1/networks リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ネットワークのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- ネットワークの種類のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ネットワークの作成
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
15.2.2. /apis/config.openshift.io/v1/networks/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ネットワークの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ネットワークの削除
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたネットワークを読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたネットワークを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたネットワークを交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第16章 Node [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- Node は、ノード固有の機能に関するクラスター全体の情報を保持します。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object - 必須
-
spec
-
16.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 は監視された値を保持します。 |
16.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| cgroupMode はノード上の cgroups バージョンを決定します |
|
|
| workerLatencyProfile は、kubelet がクラスターのステータスとそれに応じた反応を更新する速度を決定します。 |
16.1.2. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status は監視された値を保持します。
- 型
-
object
16.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/nodes-
DELETE: Node のコレクションを削除します -
GET: kind である Node のオブジェクトをリスト表示します -
POST: Node を作成します
-
/apis/config.openshift.io/v1/nodes/{name}-
削除: Node を削除します -
GET: 指定された Node を読み取ります。 -
PATCH: 指定された Node を部分的に更新します。 -
PUT: 指定された Node を置き換えます
-
/apis/config.openshift.io/v1/nodes/{name}/status-
GET: 指定された Node のステータスを読み取ります -
PATCH: 指定された Node のステータスを部分的に更新します。 -
PUT: 指定された Node のステータスを置き換えます
-
16.2.1. /apis/config.openshift.io/v1/nodes リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- Node のコレクションを削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- kind である Node のオブジェクトをリスト表示します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ノードを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
16.2.2. /apis/config.openshift.io/v1/nodes/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ノードの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- ノードの削除
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたノードを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたノードを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたノードを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
16.2.3. /apis/config.openshift.io/v1/nodes/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ノードの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定されたノードのステータスを読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたノードのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたノードのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第17章 OAuth [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
-
OAuth は、OAuth に関するクラスター全体の情報を保持します。正規名は
clusterです。統合された OAuth サーバーを設定するために使用されます。この設定は、最上位の認証設定のタイプが IntegratedOAuth に設定されている場合にのみ適用されます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object - 必須
-
spec
-
17.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 クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
17.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- spec は、ユーザーが設定可能な設定値を保持します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| identityProviders は、ユーザーが自分自身を識別するための方法の順序付きリストです。このリストが空の場合、ID はユーザーにプロビジョニングされません。 |
|
|
| IdentityProvider は、認証情報を使用して認証するユーザーに ID を提供します |
|
|
| テンプレートを使用すると、ログインページなどのページをカスタマイズできます。 |
|
|
| tokenConfig には、認証トークンとアクセストークンのオプションが含まれています |
17.1.2. .spec.identityProviders リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- identityProviders は、ユーザーが自分自身を識別するための方法の順序付きリストです。このリストが空の場合、ID はユーザーにプロビジョニングされません。
- 型
-
array
17.1.3. .spec.identityProviders[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- IdentityProvider は、認証情報を使用して認証するユーザーに ID を提供します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| basicAuth には、BasicAuth IdP の設定オプションが含まれています |
|
|
| github は、GitHub クレデンシャルを使用したユーザー認証を有効にします |
|
|
| gitlab は、GitLab クレデンシャルを使用したユーザー認証を有効にします |
|
|
| google は、Google クレデンシャルを使用したユーザー認証を有効にします |
|
|
| htpasswd は、HTPasswd ファイルを使用したユーザー認証を有効にして認証情報を検証します |
|
|
| keystone は、keystone パスワードクレデンシャルを使用したユーザー認証を有効にします |
|
|
| ldap は、LDAP クレデンシャルを使用したユーザー認証を有効にします |
|
|
| mappingMethod は、このプロバイダーからの ID がユーザーにどのようにマップされるかを決定します。デフォルトは "claim" です。 |
|
|
| name は、このプロバイダーによって返されるアイデンティティーを修飾するために使用されます。- 一意であり、使用されている他の ID プロバイダーと共有されていないようにする必要があります。- 有効なパスセグメントである必要があります。名前は "." または ".." と等しくしたり、"/" または "%" または ":" を含むことはできません。https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName を参照してください。 |
|
|
| openID は、OpenID クレデンシャルを使用したユーザー認証を有効にします |
|
|
| requestHeader は、リクエストヘッダーのクレデンシャルを使用したユーザー認証を有効にします |
|
|
| type は、このエントリーの ID プロバイダータイプを識別します。 |
17.1.4. .spec.identityProviders[].basicAuth リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- basicAuth には、BasicAuth IdP の設定オプションが含まれています
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。 |
|
|
| tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー "tls.crt" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー "tls.key" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| url は接続するリモート URL です |
17.1.5. .spec.identityProviders[].basicAuth.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.6. .spec.identityProviders[].basicAuth.tlsClientCert リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー "tls.crt" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.7. .spec.identityProviders[].basicAuth.tlsClientKey リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー "tls.key" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.8. .spec.identityProviders[].github リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- github は、GitHub クレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。これは、ホスト名が空でない値に設定されている場合にのみ設定できます。この設定マップの namespace は openshift-config です。 |
|
|
| clientID は oauth クライアント ID です |
|
|
| clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| hostname は、GitHub Enterprise のホストされたインスタンスで使用するためのオプションのドメイン ("mycompany.com" など) です。/setup/settings#hostname で設定されている GitHub Enterprise 設定値と一致する必要があります。 |
|
|
| 組織は、オプションで、ログインを許可する組織を制限します |
|
|
| チームは、オプションで、ログインを許可するチームを制限します。形式は <org>/<team> です。 |
17.1.9. .spec.identityProviders[].github.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。これは、ホスト名が空でない値に設定されている場合にのみ設定できます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.10. .spec.identityProviders[].github.clientSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.11. .spec.identityProviders[].gitlab リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- gitlab は、GitLab クレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。 |
|
|
| clientID は oauth クライアント ID です |
|
|
| clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| url は oauth サーバーのベース URL です |
17.1.12. .spec.identityProviders[].gitlab.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.13. .spec.identityProviders[].gitlab.clientSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.14. .spec.identityProviders[].google リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- google は、Google クレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| clientID は oauth クライアント ID です |
|
|
| clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| hostedDomain は、ログインを制限するオプションの Google アプリドメイン ("mycompany.com" など) です。 |
17.1.15. .spec.identityProviders[].google.clientSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.16. .spec.identityProviders[].htpasswd リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- htpasswd は、HTPasswd ファイルを使用したユーザー認証を有効にして認証情報を検証します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| fileData は、htpasswd ファイルとして使用するデータを含む名前によるシークレットへの必須の参照です。キー "htpasswd" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された htpasswd データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
17.1.17. .spec.identityProviders[].htpasswd.fileData リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- fileData は、htpasswd ファイルとして使用するデータを含む名前によるシークレットへの必須の参照です。キー "htpasswd" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された htpasswd データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.18. .spec.identityProviders[].keystone リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- keystone は、keystone パスワードクレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。 |
|
|
| keystonev3 には domainName が必要です |
|
|
| tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー "tls.crt" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー "tls.key" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| url は接続するリモート URL です |
17.1.19. .spec.identityProviders[].keystone.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.20. .spec.identityProviders[].keystone.tlsClientCert リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tlsClientCert は、サーバーに接続するときに提示する PEM エンコードされた TLS クライアント証明書を含む名前によるシークレットへのオプションの参照です。キー "tls.crt" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.21. .spec.identityProviders[].keystone.tlsClientKey リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tlsClientKey は、tlsClientCert で参照されるクライアント証明書の PEM エンコードされた TLS 秘密鍵を含む名前によるシークレットへのオプションの参照です。キー "tls.key" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された証明書データが有効でない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.22. .spec.identityProviders[].ldap リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ldap は、LDAP クレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 属性は LDAP 属性を ID にマップします |
|
|
| bindDN は、検索フェーズ中にバインドするオプションの DN です。 |
|
|
| bindPassword は、検索フェーズ中にバインドするパスワードを含む名前によるシークレットへのオプションの参照です。キー "bindPassword" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。 |
|
|
|
insecure が true の場合、接続で TLS を使用しないことを示します。警告: |
|
|
| url は、使用する LDAP 検索パラメーターを指定する RFC2255URL です。URL の構文は次のとおりです。ldap://host:port/basedn?attribute?scope?filter |
17.1.23. .spec.identityProviders[].ldap.attributes リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- 属性は LDAP 属性を ID にマップします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| email は、値を電子メールアドレスとして使用する必要がある属性のリストです。任意。指定しない場合、ID に電子メールは設定されません |
|
|
| id は、値をユーザー ID として使用する必要がある属性のリストです。必須。最初の空でない属性が使用されます。少なくとも 1 つの属性が必要です。リスト表示される属性のいずれにも値がない場合、認証は失敗します。LDAP 標準 ID 属性は "dn" です |
|
|
| 表示名として使用する必要がある値を持つ属性のリスト (文字列) です。任意。指定しない場合、ID LDAP 標準表示名属性の表示名は "cn" に設定されません。 |
|
|
| preferredUsername は、優先ユーザー名として値を使用する必要がある属性のリストです。LDAP 標準ログイン属性は "uid" です |
17.1.24. .spec.identityProviders[].ldap.bindPassword リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- bindPassword は、検索フェーズ中にバインドするパスワードを含む名前によるシークレットへのオプションの参照です。キー "bindPassword" は、データを見つけるために使用されます。指定され、シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.25. .spec.identityProviders[].ldap.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.26. .spec.identityProviders[].openID リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- openID は、OpenID クレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。 |
|
|
| クレームマッピング |
|
|
| clientID は oauth クライアント ID です |
|
|
| clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。 |
|
|
| extraAuthorizeParameters は、承認リクエストに追加するカスタムパラメーターです。 |
|
|
| extraScopes は、標準の "openid" スコープに加えて要求するスコープです。 |
|
|
| 発行者は、OpenID プロバイダーが発行者識別子としてアサートする URL です。クエリーまたはフラグメントコンポーネントのない https スキームを使用する必要があります。 |
17.1.27. .spec.identityProviders[].openID.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへのオプションの参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。キー "ca.crt" は、データを見つけるために使用されます。指定され、設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。空の場合は、デフォルトのシステムルートが使用されます。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.28. .spec.identityProviders[].openID.claims リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- クレームマッピング
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| email は、値を電子メールアドレスとして使用する必要があるクレームのリストです。任意。指定しない場合、ID に電子メールは設定されません |
|
|
| groups は、OIDC プロバイダーからユーザーの OpenShift にグループを同期するために使用する必要があるクレーム値のリストです。複数の要求が指定されている場合は、値が入力されている最初の要求が使用されます。 |
|
|
| name は、表示名として値を使用する必要があるクレームのリストです。任意。指定しない場合、ID の表示名は設定されません |
|
|
| preferredUsername は、優先ユーザー名として値を使用する必要があるクレームのリストです。指定しない場合、優先ユーザー名はサブクレームの値から決定されます |
17.1.29. .spec.identityProviders[].openID.clientSecret リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- clientSecret は、oauth クライアントシークレットを含む名前によるシークレットへの必須の参照です。キー "clientSecret" は、データを見つけるために使用されます。シークレットキーまたは期待されるキーが見つからない場合、ID プロバイダーは尊重されません。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.30. .spec.identityProviders[].requestHeader リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- requestHeader は、リクエストヘッダーのクレデンシャルを使用したユーザー認証を有効にします
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへの必須の参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。具体的には、着信要求を検証してヘッダーのなりすましを防ぐことができます。キー "ca.crt" は、データを見つけるために使用されます。設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。この設定マップの namespace は openshift-config です。 |
|
|
| challengeURL は、認証されていない/承認されたリクエストを、WWW-Authenticate チャレンジがここにリダイレクトされることを期待する OAuth クライアントからの認証されていないリクエストにリダイレクトするための URL です。$ {url}は現在の URL に置き換えられ、クエリーパラメーターで安全のためにエスケープされます https://www.example.com/sso-login?then=${url}${query} は現在のクエリー文字列に置き換えられます https://www.example.com/auth-proxy/oauth/authorize?${query} チャレンジが true に設定されている場合に必要です。 |
|
|
| clientCommonNames は、一致を要求する一般名のオプションのリストです。空の場合、clientCA バンドルに対して検証されたクライアント証明書はすべて信頼できると見なされます。 |
|
|
| emailHeaders は、メールアドレスを確認するためのヘッダーのセットです。 |
|
|
| headers は、ID 情報を確認するためのヘッダーのセットです。 |
|
|
| loginURL は認証されていない /authorize リクエストをリダイレクトする URL です。対話式ログインを期待する OAuth クライアントからの認証されていないリクエストはここにリダイレクトされます ${url} は現在の URL に置き換えられ、クエリーパラメーターとして安全なようにエスケープされます https://www.example.com/sso-login?then=${url} ${query} は現在のクエリー文字列に置き換えられます https://www.example.com/auth-proxy/oauth/authorize?${query}。login が true に設定されている場合は必須です。 |
|
|
| nameHeaders は、表示名を確認するためのヘッダーのセットです。 |
|
|
| preferredUsernameHeaders は、優先ユーザー名を確認するためのヘッダーのセットです。 |
17.1.31. .spec.identityProviders[].requestHeader.ca リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ca は、PEM でエンコードされた CA バンドルを含む名前による設定マップへの必須の参照です。リモートサーバーによって表示される TLS 証明書を検証するためにトラストアンカーとして使用されます。具体的には、着信要求を検証してヘッダーのなりすましを防ぐことができます。キー "ca.crt" は、データを見つけるために使用されます。設定マップまたは予期されるキーが見つからない場合、ID プロバイダーは尊重されません。指定された ca データが有効でない場合、ID プロバイダーは尊重されません。この設定マップの namespace は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照される設定マップの metadata.name です。 |
17.1.32. .spec.templates リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- テンプレートを使用すると、ログインページなどのページをカスタマイズできます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| error は、認証または許可フロー中にエラーページをレンダリングするために使用する go テンプレートを指定するシークレットの名前です。キー "errors.html" は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのエラーページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのエラーページが使用されます。指定しない場合、デフォルトのエラーページが使用されます。このシークレットの名前空間は openshift-config です。 |
|
|
| login は、ログインページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー "login.html" は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのログインページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのログインページが使用されます。指定しない場合、デフォルトのログインページが使用されます。このシークレットの名前空間は openshift-config です。 |
|
|
| providerSelection は、プロバイダー選択ページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー "providers.html" は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのプロバイダー選択ページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのプロバイダー選択ページが使用されます。指定されていない場合、デフォルトのプロバイダー選択ページが使用されます。このシークレットの名前空間は openshift-config です。 |
17.1.33. .spec.templates.error リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- error は、認証または許可フロー中にエラーページをレンダリングするために使用する go テンプレートを指定するシークレットの名前です。キー "errors.html" は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのエラーページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのエラーページが使用されます。指定しない場合、デフォルトのエラーページが使用されます。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.34. .spec.templates.login リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- login は、ログインページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー "login.html" は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのログインページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのログインページが使用されます。指定しない場合、デフォルトのログインページが使用されます。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.35. .spec.templates.providerSelection リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- providerSelection は、プロバイダー選択ページのレンダリングに使用する go テンプレートを指定するシークレットの名前です。キー "providers.html" は、テンプレートデータを見つけるために使用されます。指定され、秘密鍵または予期される鍵が見つからない場合は、デフォルトのプロバイダー選択ページが使用されます。指定されたテンプレートが無効な場合は、デフォルトのプロバイダー選択ページが使用されます。指定されていない場合、デフォルトのプロバイダー選択ページが使用されます。このシークレットの名前空間は openshift-config です。
- 型
-
object - 必須
-
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
17.1.36. .spec.tokenConfig リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- tokenConfig には、認証トークンとアクセストークンのオプションが含まれています
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| accessTokenInactivityTimeout は、任意のクライアントによって付与されたトークンのトークン非アクティブタイムアウトを定義します。この値は、トークンを連続して使用する間に発生する可能性のある最大時間を表します。トークンがこの一時ウィンドウ内で使用されないと、トークンは無効になります。トークンがタイムアウトしたときにアクセスを回復するには、ユーザーは新しいトークンを取得する必要があります。"5m"、"1.5h"、"2h45m" などの有効な期間文字列を取ります。継続時間の最小許容値は 300 秒 (5 分) です。クライアントごとにタイムアウトが設定されている場合は、その値が優先されます。タイムアウト値が指定されておらず、クライアントが値をオーバーライドしない場合、トークンはその存続期間まで有効です。警告: この値を変更しても、既存のトークンのタイムアウトは影響を受けません (低下します)。 |
|
|
| accessTokenInactivityTimeoutSeconds- 非推奨: このフィールドを設定しても効果はありません。 |
|
|
| accessTokenMaxAgeSeconds は、アクセストークンの最大有効期間を定義します |
17.1.37. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- 型
-
object
17.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/oauths-
DELETE:OAuth のコレクションを削除します -
GET: 種類 OAuth のオブジェクトをリスト表示します -
POST:OAuth を作成します
-
/apis/config.openshift.io/v1/oauths/{name}-
削除:OAuth を削除します -
GET: 指定された OAuth を読み取ります -
PATCH: 指定された OAuth を部分的に更新します -
PUT: 指定された OAuth を置き換えます
-
/apis/config.openshift.io/v1/oauths/{name}/status-
GET: 指定された OAuth のステータスを読み取ります -
PATCH: 指定された OAuth のステータスを部分的に更新します -
PUT: 指定された OAuth のステータスを置き換えます
-
17.2.1. /apis/config.openshift.io/v1/oauths リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- OAuth のコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- OAuth の種類のオブジェクトをリスト表示する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが "BOOKMARK" の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの判断で送信されます。クライアントは、ブックマークが特定の間隔で返される、またはサーバーがセッション中に BOOKMARK イベントを送信すると想定するべきではありません。これが watch でない場合は、このフィールドが無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することが強く推奨されます。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
|
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- OAuth を作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
17.2.2. /apis/config.openshift.io/v1/oauths/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuth の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE - 説明
- OAuth を削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された OAuth を読み取ります
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された OAuth を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された OAuth を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
17.2.3. /apis/config.openshift.io/v1/oauths/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| OAuth の名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET - 説明
- 指定された OAuth のステータスを読み取る
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された OAuth のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された OAuth のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第18章 OperatorHub [config.openshift.io/v1] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorHub は、operatorhubs API のスキーマです。これを使用して、クラスター上の OperatorHub のデフォルトハブソースの状態を有効から無効に、またはその逆に変更できます。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
- 型
-
object
18.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 を参照してください。 | |
|
|
| OperatorHubSpec は、OperatorHub の目的の状態を定義します |
|
|
| OperatorHubStatus は、OperatorHub の監視状態を定義します。デフォルトのハブソースの現在の状態は、常にここに反映されます。 |
18.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorHubSpec は、OperatorHub の目的の状態を定義します
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| disableAllDefaultSources を使用すると、すべてのデフォルトハブソースを無効にできます。これが当てはまる場合、ソースの特定のエントリーを使用して、デフォルトのソースを有効にすることができます。これが false の場合、ソースの特定のエントリーを使用して、デフォルトのソースを無効または有効にすることができます。 |
|
|
| ソースは、デフォルトのハブソースとその設定のリストです。リストが空の場合、disableAllDefaultSources が true でない限り、デフォルトのハブソースがクラスターで有効になっていることを意味します。disableAllDefaultSources が true で、sources が空でない場合、sources に存在する設定が優先されます。デフォルトのハブソースとその現在の状態のリストは、常にステータスブロックに反映されます。 |
|
|
| HubSource は、ハブソースとその設定を指定するために使用されます |
18.1.2. .spec.sources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ソースは、デフォルトのハブソースとその設定のリストです。リストが空の場合、disableAllDefaultSources が true でない限り、デフォルトのハブソースがクラスターで有効になっていることを意味します。disableAllDefaultSources が true で、sources が空でない場合、sources に存在する設定が優先されます。デフォルトのハブソースとその現在の状態のリストは、常にステータスブロックに反映されます。
- 型
-
array
18.1.3. .spec.sources[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- HubSource は、ハブソースとその設定を指定するために使用されます
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 無効は、クラスター上のデフォルトのハブソースを無効にするために使用されます |
|
|
| name は、デフォルトのハブソースの 1 つの名前です。 |
18.1.4. .status リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- OperatorHubStatus は、OperatorHub の監視状態を定義します。デフォルトのハブソースの現在の状態は、常にここに反映されます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ソースは、各ハブソースの設定を適用した結果をカプセル化します |
|
|
| HubSourceStatus は、設定をデフォルトのソースに適用する現在の状態を反映するために使用されます |
18.1.5. .status.sources リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- ソースは、各ハブソースの設定を適用した結果をカプセル化します
- 型
-
array
18.1.6. .status.sources[] リンクのコピーリンクがクリップボードにコピーされました!
- 説明
- HubSourceStatus は、設定をデフォルトのソースに適用する現在の状態を反映するために使用されます
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 無効は、クラスター上のデフォルトのハブソースを無効にするために使用されます |
|
|
| メッセージは、障害に関する詳細情報を提供します |
|
|
| name は、デフォルトのハブソースの 1 つの名前です。 |
|
|
| ステータスは、設定の適用の成功または失敗を示します |
18.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/operatorhubs-
DELETE:OperatorHub のコレクションを削除します -
GET: 種類 OperatorHub のオブジェクトをリスト表示します -
POST:OperatorHub を作成します
-
/apis/config.openshift.io/v1/operatorhubs/{name}-
削除:OperatorHub を削除します -
GET: 指定された OperatorHub を読み取ります -
PATCH: 指定された OperatorHub を部分的に更新します -
PUT: 指定された OperatorHub を置き換えます
-
/apis/config.openshift.io/v1/operatorhubs/{name}/status-
GET: 指定された OperatorHub のステータスを読み取ります -
PATCH: 指定された OperatorHub のステータスを部分的に更新します -
PUT: 指定された OperatorHub のステータスを置き換えます
-