Red Hat Summitノード API
ノード API のリファレンスガイド
概要
第1章 ノード API
1.1. Node [v1]
- 説明
- Node は Kubernetes のワーカーノードです。各ノードは、キャッシュ内 (つまり、etcd 内) に一意の識別子を持ちます。
- 型
-
object
1.2. PerformanceProfile [performance.openshift.io/v2]
- 説明
- PerformanceProfile は performanceprofiles のスキーマです。
- 型
-
object
1.3. Profile [tuned.openshift.io/v1]
- 説明
- Profile は、Profile リソースの仕様です。
- 型
-
object
1.4. RuntimeClass [node.k8s.io/v1]
- 説明
- RuntimeClass は、クラスターでサポートされるコンテナーランタイムのクラスを定義します。RuntimeClass は、Pod 内のすべてのコンテナーを実行するために使用されるコンテナーランタイムを決定するために使用されます。RuntimeClasses は、ユーザーまたはクラスタープロビジョナーによって手動で定義され、PodSpec で参照されます。Kubelet は、Pod を実行する前に RuntimeClassName 参照を解決する責任があります。詳細は、https://kubernetes.io/docs/concepts/containers/runtime-class/ を参照してください。
- 型
-
object
1.5. Tuned [tuned.openshift.io/v1]
- 説明
- Tuned は、ノードレベルの sysctl をクラスター全体にデプロイし、ユーザーのニーズによって指定されたカスタムチューニングを追加するための柔軟性を高めるルールのコレクションです。これらのルールは変換され、デーモンが理解できる形式でクラスター内で実行されているすべてのコンテナー化された Tuned デーモンに渡されます。ノードレベルのチューニングを適用する責任は、コンテナー化された Tuned デーモンにあります。詳細: https://github.com/openshift/cluster-node-tuning-operator
- 型
-
object
第2章 Node [v1]
- 説明
- Node は Kubernetes のワーカーノードです。各ノードは、キャッシュ内 (つまり、etcd 内) に一意の識別子を持ちます。
- 型
-
object
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 | |
|
|
| NodeSpec は、ノードの作成に使用される属性を記述します。 |
|
|
| NodeStatus は、ノードの現在のステータスに関する情報です。 |
2.1.1. .spec
- 説明
- NodeSpec は、ノードの作成に使用される属性を記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました |
|
|
| 非推奨。すべての kubelets がこのフィールドを設定するわけではありません。1.13 以降のフィールドを削除します。参照: https://issues.k8s.io/61966 |
|
|
| podCIDR は、ノードに割り当てられた Pod IP 範囲を表します。 |
|
|
| podCIDRs は、そのノードの Pod で使用するためにノードに割り当てられた IP 範囲を表します。このフィールドを指定する場合、0 番目のエントリーは podCIDR フィールドと一致する必要があります。IPv4 と IPv6 のそれぞれに対して最大 1 つの値を含めることができます。 |
|
|
| <ProviderName>://<ProviderSpecificNodeID> の形式でクラウドプロバイダーによって割り当てられたノードの ID |
|
|
| 指定した場合、ノードのテイント。 |
|
|
| この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。 |
|
|
| Unschedulable は、新しい Pod のノードのスケジュール可能性を制御します。デフォルトでは、ノードはスケジュール可能です。詳細: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration |
2.1.2. .spec.configSource
- 説明
- NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration |
2.1.3. .spec.configSource.configMap
- 説明
- ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
- 型
-
object - 必須
-
namespace -
name -
kubeletConfigKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。 |
|
|
| Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。 |
|
|
| 名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。 |
|
|
| ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
|
|
| UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
2.1.4. .spec.taints
- 説明
- 指定した場合、ノードのテイント。
- 型
-
array
2.1.5. .spec.taints[]
- 説明
- この Taint が接続されているノードは、Taint を許容しない Pod に "影響を及ぼし" ます。
- 型
-
object - 必須
-
key -
effect
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。
使用可能な列挙値: - |
|
|
| 必須。ノードに適用されるテイントキー。 |
|
| TimeAdded は、テイントが追加された時刻を表します。NoExecute テイントにのみ作成されます。 | |
|
|
| テイントキーに対応するテイント値。 |
2.1.6. .status
- 説明
- NodeStatus は、ノードの現在のステータスに関する情報です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードに到達可能なアドレスのリスト。可能な場合は、クラウドプロバイダーから照会されます。詳細: https://kubernetes.io/docs/reference/node/node-status/#addresses 注記: このフィールドはマージ可能として宣言されていますが、マージキーは十分に一意ではないため、マージ時にデータが破損する可能性があります。代わりに、呼び出し元は完全置換パッチを使用する必要があります。例は、https://pr.k8s.io/79391 を参照してください。コンシューマーは、ノードの存続期間中にアドレスが変更される可能性があることを前提とする必要があります。ただし、独自のステータスでノードのアドレスを継承する Pod や下位 API (status.hostIP) のコンシューマーなど、これが不可能な例外もいくつかあります。 |
|
|
| NodeAddress には、ノードのアドレスに関する情報が含まれています。 |
|
| Allocatable は、スケジューリングに使用できるノードのリソースを表します。デフォルトは容量です。 | |
|
| 容量は、ノードの合計リソースを表します。詳細: https://kubernetes.io/docs/reference/node/node-status/#capacity | |
|
|
| 条件は、現在観測されているノード条件の配列です。詳細: https://kubernetes.io/docs/reference/node/node-status/#condition |
|
|
| NodeCondition には、ノードの条件情報が含まれています。 |
|
|
| NodeConfigStatus は、Node.Spec.ConfigSource によって割り当てられた設定のステータスを記述します。 |
|
|
| NodeDaemonEndpoints は、ノードで実行されているデーモンによって開かれたポートをリスト表示します。 |
|
|
| NodeFeatures は、CRI 実装によって実装される機能のセットを記述します。NodeFeatures に含まれる機能は、ランタイムハンドラーから独立した cri 実装にのみ依存します。 |
|
|
| このノードのコンテナーイメージのリスト |
|
|
| コンテナーのイメージを説明する |
|
|
| NodeSystemInfo は、ノードを一意に識別するための id/uuid のセットです。 |
|
|
| NodePhase は、ノードの最近観察されたライフサイクルフェーズです。詳細: https://kubernetes.io/docs/concepts/nodes/node/#phase フィールドにデータが入力されることはなく、現在は非推奨になっています。
使用可能な列挙値: - |
|
|
| 使用可能なランタイムハンドラー。 |
|
|
| NodeRuntimeHandler は、ランタイムハンドラー情報のセットです。 |
|
|
| ノードに接続されているボリュームのリスト。 |
|
|
| AttachedVolume は、ノードに接続されているボリュームを表します |
|
|
| ノードによって使用中 (マウント済み) の接続可能なボリュームのリスト。 |
2.1.7. .status.addresses
- 説明
- ノードに到達可能なアドレスのリスト。可能な場合は、クラウドプロバイダーから照会されます。詳細: https://kubernetes.io/docs/reference/node/node-status/#addresses 注記: このフィールドはマージ可能として宣言されていますが、マージキーは十分に一意ではないため、マージ時にデータが破損する可能性があります。代わりに、呼び出し元は完全置換パッチを使用する必要があります。例は、https://pr.k8s.io/79391 を参照してください。コンシューマーは、ノードの存続期間中にアドレスが変更される可能性があることを前提とする必要があります。ただし、独自のステータスでノードのアドレスを継承する Pod や下位 API (status.hostIP) のコンシューマーなど、これが不可能な例外もいくつかあります。
- 型
-
array
2.1.8. .status.addresses[]
- 説明
- NodeAddress には、ノードのアドレスに関する情報が含まれています。
- 型
-
object - 必須
-
type -
address
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードアドレス。 |
|
|
| ノードアドレスタイプ。ホスト名、ExternalIP、または InternalIP のいずれか。 |
2.1.9. .status.conditions
- 説明
- 条件は、現在観測されているノード条件の配列です。詳細: https://kubernetes.io/docs/reference/node/node-status/#condition
- 型
-
array
2.1.10. .status.conditions[]
- 説明
- NodeCondition には、ノードの条件情報が含まれています。
- 型
-
object - 必須
-
type -
status
-
2.1.11. .status.config
- 説明
- NodeConfigStatus は、Node.Spec.ConfigSource によって割り当てられた設定のステータスを記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました |
|
|
| NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました |
|
|
| エラーは、Spec.ConfigSource をアクティブな設定に調整する際の問題を示しています。たとえば、Spec.ConfigSource をローカルの Assigned レコードにチェックポイントしようとしたり、Spec.ConfigSource に関連付けられたペイロードをチェックポイントしようとしたり、Assigned config をロードまたは検証しようとしたりするなどのエラーが発生する可能性があります。設定の同期中に、さまざまなポイントでエラーが発生する場合があります。以前のエラー (ダウンロードエラーやチェックポイントエラーなど) は、LastKnownGood へのロールバックにはならず、Kubelet の再試行全体で解決される可能性があります。その後のエラー (チェックポイント設定のロードや検証など) は、LastKnownGood へのロールバックになります。後者の場合、通常、Spec.ConfigSource で割り当てられた設定を修正することでエラーを解決できます。Kubelet ログでエラーメッセージを検索すると、デバッグに関する追加情報を見つけることができます。エラーは、人間が読める形式のエラー状態の説明です。マシンはエラーが空であるかどうかをチェックできますが、Kubelet バージョン間でのエラーテキストの安定性に依存するべきではありません。 |
|
|
| NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました |
2.1.12. .status.config.active
- 説明
- NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration |
2.1.13. .status.config.active.configMap
- 説明
- ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
- 型
-
object - 必須
-
namespace -
name -
kubeletConfigKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。 |
|
|
| Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。 |
|
|
| 名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。 |
|
|
| ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
|
|
| UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
2.1.14. .status.config.assigned
- 説明
- NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration |
2.1.15. .status.config.assigned.configMap
- 説明
- ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
- 型
-
object - 必須
-
namespace -
name -
kubeletConfigKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。 |
|
|
| Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。 |
|
|
| 名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。 |
|
|
| ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
|
|
| UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
2.1.16. .status.config.lastKnownGood
- 説明
- NodeConfigSource は、ノード設定のソースを指定します。正確に 1 つのサブフィールド (メタデータを除く) は nil 以外である必要があります。この API は 1.22 以降非推奨になりました
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration |
2.1.17. .status.config.lastKnownGood.configMap
- 説明
- ConfigMapNodeConfigSource には、ノードの設定ソースとして ConfigMap を参照するための情報が含まれています。この API は 1.22 以降非推奨になりました: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration
- 型
-
object - 必須
-
namespace -
name -
kubeletConfigKey
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| KubeletConfigKey は、参照される ConfigMap のどのキーが KubeletConfiguration 構造に対応するかを宣言します。このフィールドはすべての場合に必須です。 |
|
|
| Name は、参照される ConfigMap の metadata.name です。このフィールドはすべての場合に必須です。 |
|
|
| 名前空間は、参照される ConfigMap の metadata.namespace です。このフィールドはすべての場合に必須です。 |
|
|
| ResourceVersion は、参照される ConfigMap の metadata.ResourceVersion です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
|
|
| UID は、参照される ConfigMap の metadata.UID です。このフィールドは Node.Spec では禁止されており、Node.Status では必須です。 |
2.1.18. .status.daemonEndpoints
- 説明
- NodeDaemonEndpoints は、ノードで実行されているデーモンによって開かれたポートをリスト表示します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| DaemonEndpoint には、単一のデーモンエンドポイントに関する情報が含まれています。 |
2.1.19. .status.daemonEndpoints.kubeletEndpoint
- 説明
- DaemonEndpoint には、単一のデーモンエンドポイントに関する情報が含まれています。
- 型
-
object - 必須
-
Port
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 指定されたエンドポイントのポート番号。 |
2.1.20. .status.features
- 説明
- NodeFeatures は、CRI 実装によって実装される機能のセットを記述します。NodeFeatures に含まれる機能は、ランタイムハンドラーから独立した cri 実装にのみ依存します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ランタイムが SupplementalGroupsPolicy と ContainerUser をサポートしている場合、SupplementalGroupsPolicy は true に設定されます。 |
2.1.21. .status.images
- 説明
- このノードのコンテナーイメージのリスト
- 型
-
array
2.1.22. .status.images[]
- 説明
- コンテナーのイメージを説明する
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| このイメージが知られている名前 (例: ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"])。 |
|
|
| イメージのサイズ (バイト単位)。 |
2.1.23. .status.nodeInfo
- 説明
- NodeSystemInfo は、ノードを一意に識別するための id/uuid のセットです。
- 型
-
object - 必須
-
machineID -
systemUUID -
bootID -
kernelVersion -
osImage -
containerRuntimeVersion -
kubeletVersion -
kubeProxyVersion -
operatingSystem -
architecture
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードによって報告されたアーキテクチャー |
|
|
| ノードによって報告されたブート ID。 |
|
|
| ランタイムリモート API を通じてノードによって報告される ContainerRuntime バージョン (containerd://1.4.2 など)。 |
|
|
| 'uname -r' からノードによって報告されたカーネルバージョン (例:3.16.0-0.bpo.4-amd64)。 |
|
|
| 非推奨: ノードによって報告された KubeProxy バージョン。 |
|
|
| ノードによって報告された Kubelet バージョン。 |
|
|
| ノードによって報告された MachineID。クラスター内の一意のマシン識別には、このフィールドが推奨されます。man(5) machine-id の詳細:http: //man7.org/linux/man-pages/man5/machine-id.5.html |
|
|
| ノードによって報告されたオペレーティングシステム |
|
|
| /etc/os-release からノードによって報告された OS イメージ (例:Debian GNU/Linux 7(wheezy))。 |
|
|
| NodeSwapStatus はスワップメモリー情報を表します。 |
|
|
| ノードによって報告された SystemUUID。一意のマシン識別には、MachineID が推奨されます。このフィールドは、Red Hat ホストに固有です https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid |
2.1.24. .status.nodeInfo.swap
- 説明
- NodeSwapStatus はスワップメモリー情報を表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| スワップメモリーの合計量 (バイト単位)。 |
2.1.25. .status.runtimeHandlers
- 説明
- 使用可能なランタイムハンドラー。
- 型
-
array
2.1.26. .status.runtimeHandlers[]
- 説明
- NodeRuntimeHandler は、ランタイムハンドラー情報のセットです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| NodeRuntimeHandlerFeatures は、ランタイムハンドラーによって実装される機能のセットです。 |
|
|
| ランタイムハンドラー名。デフォルトのランタイムハンドラーの場合は空です。 |
2.1.27. .status.runtimeHandlers[].features
- 説明
- NodeRuntimeHandlerFeatures は、ランタイムハンドラーによって実装される機能のセットです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ランタイムハンドラーが RecursiveReadOnlyMounts をサポートしている場合、RecursiveReadOnlyMounts は true に設定されます。 |
|
|
| ランタイムハンドラーがボリュームを含む UserNamespaces をサポートしている場合、UserNamespaces は true に設定されます。 |
2.1.28. .status.volumesAttached
- 説明
- ノードに接続されているボリュームのリスト。
- 型
-
array
2.1.29. .status.volumesAttached[]
- 説明
- AttachedVolume は、ノードに接続されているボリュームを表します
- 型
-
object - 必須
-
name -
devicePath
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| DevicePath は、ボリュームが使用可能である必要があるデバイスパスを表します |
|
|
| 接続されたボリュームの名前 |
2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/nodes-
DELETE: Node のコレクションを削除します。 -
GET: 種類が Node のオブジェクトをリスト表示または監視します。 -
POST: Node を作成します。
-
/api/v1/watch/nodes-
GET: Node のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/nodes/{name}-
DELETE: Node を削除します。 -
GET: 指定された Node を読み取ります。 -
PATCH: 指定された Node を部分的に更新します。 -
PUT: 指定された Node を置き換えます。
-
/api/v1/watch/nodes/{name}-
GET: 種類が Node のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルタリングしてください。
-
/api/v1/nodes/{name}/status-
GET: 指定された Node のステータスを読み取ります。 -
PATCH: 指定された Node のステータスを部分的に更新します。 -
PUT: 指定された Node のステータスを置き換えます。
-
2.2.1. /api/v1/nodes
- HTTP メソッド
-
DELETE - 説明
- Node のコレクションを削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Node のオブジェクトをリスト表示または監視します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ノードを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
2.2.2. /api/v1/watch/nodes
- HTTP メソッド
-
GET - 説明
- Node のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
2.2.3. /api/v1/nodes/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ノードの名前 |
- HTTP メソッド
-
DELETE - 説明
- ノードの削除
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたノードを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたノードを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
- HTTP メソッド
-
PUT - 説明
- 指定されたノードを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
2.2.4. /api/v1/watch/nodes/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ノードの名前 |
- HTTP メソッド
-
GET - 説明
- ノードの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
2.2.5. /api/v1/nodes/{name}/status
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ノードの名前 |
- HTTP メソッド
-
GET - 説明
- 指定されたノードのステータスを読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたノードのステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
- HTTP メソッド
-
PUT - 説明
- 指定されたノードのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第3章 PerformanceProfile [performance.openshift.io/v2]
- 説明
- PerformanceProfile は performanceprofiles のスキーマです。
- 型
-
object
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 | |
|
|
| PerformanceProfileSpec は、PerformanceProfile の望ましい状態を定義します。 |
|
|
| PerformanceProfileStatus は、PerformanceProfile の観測された状態を定義します。 |
3.1.1. .spec
- 説明
- PerformanceProfileSpec は、PerformanceProfile の望ましい状態を定義します。
- 型
-
object - 必須
-
cpu -
nodeSelector
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 追加のカーネル引数。 |
|
|
| CPU は、CPU 関連のパラメーターのセットを定義します。 |
|
|
| GloballyDisableIrqLoadBalancing は、分離された CPU セットの IRQ 負荷分散を無効にするかどうかを切り替えます。オプションを "true" に設定すると、分離された CPU セットの IRQ 負荷分散が無効になります。オプションを "false" に設定すると、すべての CPU 間で IRQ を分散できます。ただし、irq-load-balancing.crio.io/cpu-quota.crio.io アノテーションを使用すると、Pod の CPU ごとに IRQ の負荷分散を無効にできます。デフォルトは "false" です。 |
|
|
| HardwareTuning は、分離された CPU と予約された CPU の CPU 周波数のセットを定義します。 |
|
|
| HugePages は、huge page に関連するパラメーターのセットを定義します。huge page には複数のサイズ値を同時に設定することが可能です。たとえば、hugepages は 1G と 2M に設定できます。どちらの値もパフォーマンスプロファイルコントローラーによってノードに設定されます。hugepages のデフォルトサイズを 1G に設定すると、ノードから 2M に関連するフォルダーがすべて削除され、ノードに 2M の hugepages を設定できなくなることに注意することが重要です。 |
|
|
| kernelPageSize は、カーネルページサイズを定義します。4k がデフォルトです。64k は aarch64 でのみサポートされます。 |
|
|
| MachineConfigLabel は、Operator が作成する MachineConfig に追加するラベルを定義します。このパフォーマンスプロファイルを対象とする MachineConfigPool の MachineConfigSelector で使用する必要があります。デフォルトは、"machineconfiguration.openshift.io/role=<NodeSelector ラベルキーと同じロール>" です。 |
|
|
| MachineConfigPoolSelector は、Operator によって作成された KubeletConfigs などのリソースの MachineConfigPoolSelector で使用する MachineConfigPool ラベルを定義します。デフォルトは、"machineconfiguration.openshift.io/role=<NodeSelector ラベルキーと同じロール>" です。 |
|
|
| Net は、ネットワーク関連の機能のセットを定義します。 |
|
|
| NodeSelector は、Operator によって作成された Tuned などのリソースの NodeSelectors で使用するノードラベルを定義します。ほとんどの場合、このパフォーマンスプロファイルを対象とする MachineConfigPool の NodeSelector 内のノードラベルと一致しますが、必ずしも一致する必要はありません。machineConfigLabels または machineConfigPoolSelector が設定されていない場合、前述のフィールドのデフォルト値を計算できるように、<domain>/<role>: "" という特定の NodeSelector 形式が必要です。 |
|
|
| NUMA は、トポロジーを意識したアフィニティーに関連するオプションを定義します。 |
|
|
| RealTimeKernel は、リアルタイムカーネル関連のパラメーターのセットを定義します。設定されていない場合、RT カーネルはインストールされません。 |
|
|
| WorkloadHints は、さまざまな種類のワークロードのヒントを定義します。これにより、ノードに適用する必要があるチューニング済み引数とカーネル引数の正確なセットを定義できます。 |
3.1.2. .spec.cpu
- 説明
- CPU は、CPU 関連のパラメーターのセットを定義します。
- 型
-
object - 必須
-
isolated -
reserved
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| BalanceIsolated は、分離された CPU セットを負荷分散ワークロードの対象とするどうかを切り替えます。このオプションを "false" に設定すると、分離された CPU セットは静的になります。つまり、複数の CPU 間で機能するために、ワークロードが各スレッドを特定の CPU に明示的に割り当てる必要があります。これを "true" に設定すると、CPU 間でワークロードを分散できます。これを "false" に設定すると、保証されたワークロードのパフォーマンスが最も予測可能なものになりますが、アプリケーションが CPU 負荷分散の複雑さを肩代わりすることになります。デフォルトは "true" です。 |
|
|
| Isolated は、アプリケーションスレッドに可能な限り最大の実行時間を与えるために使用する CPU のセットを定義します。つまり、CPU からできるだけ多くの余分なタスクを削除することになります。CPU マネージャーが、ワークロードを実行するために、予約済み CPU を除く任意の CPU を選択できることに注意することが重要です。ワークロードを分離された CPU 上で確実に実行するには、次の条件を満たす必要があります。1. 予約済み CPU と分離された CPU の集合に、すべてのオンライン CPU が含まれている必要があります。2. 分離された CPU のフィールドが予約済み CPU のフィールドを補完するものである必要があります。 |
|
|
| Offline は、オフラインに設定して使用しない CPU のセットを定義します。 |
|
|
| Reserved は、kubelet によって開始されたコンテナーワークロードに使用しない CPU のセットを定義します。 |
|
|
| Shared は、すでにワークロードによって使用されている分離された排他的リソースに加えて、排他的ではない追加の CPU を必要とする保証されたワークロード間で共有される CPU セットを定義します。 |
3.1.3. .spec.hardwareTuning
- 説明
- HardwareTuning は、分離された CPU と予約された CPU の CPU 周波数のセットを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| IsolatedCpuFreq は、分離された CPU に設定する最小周波数を定義します。 |
|
|
| ReservedCpuFreq は、予約済み CPU に設定する最小周波数を定義します。 |
3.1.4. .spec.hugepages
- 説明
- HugePages は、huge page に関連するパラメーターのセットを定義します。huge page には複数のサイズ値を同時に設定することが可能です。たとえば、hugepages は 1G と 2M に設定できます。どちらの値もパフォーマンスプロファイルコントローラーによってノードに設定されます。hugepages のデフォルトサイズを 1G に設定すると、ノードから 2M に関連するフォルダーがすべて削除され、ノードに 2M の hugepages を設定できなくなることに注意することが重要です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| DefaultHugePagesSize は、カーネルブートパラメーター配下の huge page のデフォルトサイズを定義します。 |
|
|
| Pages は、起動時に割り当てる huge page を定義します。 |
|
|
| HugePage は、割り当てられる特定サイズの huge page の数を定義します。 |
3.1.5. .spec.hugepages.pages
- 説明
- Pages は、起動時に割り当てる huge page を定義します。
- 型
-
array
3.1.6. .spec.hugepages.pages[]
- 説明
- HugePage は、割り当てられる特定サイズの huge page の数を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Count は、huge page の数を定義し、'hugepages' カーネルブートパラメーターにマップします。 |
|
|
| Node は、huge page を割り当てる NUMA ノードを定義します。指定されていない場合、ページは NUMA ノード間で均等に割り当てられます。 |
|
|
| Size は、huge page のサイズを定義し、'hugepagesz' カーネルブートパラメーターにマップします。 |
3.1.7. .spec.net
- 説明
- Net は、ネットワーク関連の機能のセットを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Devices には、CPU.Reserved と等しい netqueue の数を使用して設定されるネットワークデバイス表現のリストを含めます。デバイスが指定されていない場合、デフォルトはすべてのデバイスです。 |
|
|
| Device は、デバイス名、ベンダー ID、モデル ID、PCI パス、MAC アドレスなど、いくつかのオプションでネットワークデバイスを表す方法を定義します。 |
|
|
| UserLevelNetworking を有効にすると、すべてのネットワークデバイスまたは指定されたネットワークデバイスのキューサイズが予約済み CPU の量に設定されます。デフォルトは "false" です。 |
3.1.8. .spec.net.devices
- 説明
- Devices には、CPU.Reserved と等しい netqueue の数を使用して設定されるネットワークデバイス表現のリストを含めます。デバイスが指定されていない場合、デフォルトはすべてのデバイスです。
- 型
-
array
3.1.9. .spec.net.devices[]
- 説明
- Device は、デバイス名、ベンダー ID、モデル ID、PCI パス、MAC アドレスなど、いくつかのオプションでネットワークデバイスを表す方法を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 16 ビットの 16 進数として表されるネットワークデバイス ID (モデル)。 |
|
|
| 照合するネットワークデバイス名。正または負のシェルスタイルのワイルドカードの構文を使用します。 |
|
|
| 16 ビットの 16 進数として表されるネットワークデバイスベンダー ID。 |
3.1.10. .spec.numa
- 説明
- NUMA は、トポロジーを意識したアフィニティーに関連するオプションを定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| TopologyManager が有効な場合に適用されるポリシーの名前。Operator のデフォルトは "best-effort" です。 |
3.1.11. .spec.realTimeKernel
- 説明
- RealTimeKernel は、リアルタイムカーネル関連のパラメーターのセットを定義します。設定されていない場合、RT カーネルはインストールされません。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Enabled は、リアルタイムカーネルパッケージをインストールするかどうかを定義します。デフォルトは "false" です。 |
3.1.12. .spec.workloadHints
- 説明
- WorkloadHints は、さまざまな種類のワークロードのヒントを定義します。これにより、ノードに適用する必要があるチューニング済み引数とカーネル引数の正確なセットを定義できます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| HighPowerConsumption は、ノードを高電力消費モードに設定するかどうかを定義します。このフラグは電力消費に影響しますが、CPU のレイテンシーが改善されます。デフォルトは false です。 |
|
|
| MixedCpus は、ノードで mixed-cpu-node-plugin を有効にします。デフォルトは false です。 |
|
|
| PerPodPowerManagement は、ノードに Pod ごとの電源管理を設定する必要があるかどうかを定義します。PerPodPowerManagement ヒントと HighPowerConsumption ヒントを同時に有効にすることはできません。デフォルトは false です。 |
|
|
| RealTime は、ノードをリアルタイムワークロード用に設定する必要があるかどうかを定義します。デフォルトは true です。 |
3.1.13. .status
- 説明
- PerformanceProfileStatus は、PerformanceProfile の観測された状態を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Conditions は、現在の状態として観察される最新の状態を表します。 |
|
|
| Condition は、Operator の調整機能の状態を表します。 |
|
|
| RuntimeClass には、Operator によって作成された RuntimeClass リソースの名前が含まれます。 |
|
|
| Tuned は、この Operator によって生成されたチューニング値を含む Tuned カスタムリソースオブジェクトを指します。 |
3.1.14. .status.conditions
- 説明
- Conditions は、現在の状態として観察される最新の状態を表します。
- 型
-
array
3.1.15. .status.conditions[]
- 説明
- Condition は、Operator の調整機能の状態を表します。
- 型
-
object - 必須
-
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| ConditionType は、Operator の調整機能の状態です。 |
3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/performance.openshift.io/v2/performanceprofiles-
DELETE: PerformanceProfile のコレクションを削除します。 -
GET: 種類が PerformanceProfile のオブジェクトをリスト表示します。 -
POST: PerformanceProfile を作成します。
-
/apis/performance.openshift.io/v2/performanceprofiles/{name}-
DELETE: PerformanceProfile を削除します。 -
GET: 指定された PerformanceProfile を読み取ります。 -
PATCH: 指定された PerformanceProfile を部分的に更新します。 -
PUT: 指定された PerformanceProfile を置き換えます。
-
/apis/performance.openshift.io/v2/performanceprofiles/{name}/status-
GET: 指定された PerformanceProfile のステータスを読み取ります。 -
PATCH: 指定された PerformanceProfile のステータスを部分的に更新します。 -
PUT: 指定された PerformanceProfile のステータスを置き換えます。
-
3.2.1. /apis/performance.openshift.io/v2/performanceprofiles
- HTTP メソッド
-
DELETE - 説明
- PerformanceProfile のコレクションを削除します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が PerformanceProfile のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- PerformanceProfile を作成します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
3.2.2. /apis/performance.openshift.io/v2/performanceprofiles/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| PerformanceProfile の名前 |
- HTTP メソッド
-
DELETE - 説明
- PerformanceProfile を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された PerformanceProfile を読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された PerformanceProfile を部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された PerformanceProfile を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
3.2.3. /apis/performance.openshift.io/v2/performanceprofiles/{name}/status
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| PerformanceProfile の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された PerformanceProfile のステータスを読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された PerformanceProfile のステータスを部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された PerformanceProfile のステータスを置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第4章 Profile [tuned.openshift.io/v1]
- 説明
- Profile は、Profile リソースの仕様です。
- 型
-
object
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 | |
|
|
| |
|
|
| ProfileStatus は、プロファイルリソースのステータスです。ステータスは内部使用のみであり、そのフィールドは将来変更/削除される可能性があります。 |
4.1.1. .spec
- 説明
- 型
-
object - 必須
-
config
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| |
|
|
| Tuned プロファイル |
|
|
| 調整されたプロファイル。 |
4.1.2. .spec.config
- 説明
- 型
-
object - 必須
-
tunedProfile
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| TuneD デーモンの実行をデバッグするオプション |
|
|
| ノードの providerID から取得したクラウドプロバイダーの名前: <ProviderName>://<ProviderSpecificNodeID> |
|
|
| tuned-main.conf で定義されている TuneD デーモンのグローバル設定 |
|
|
| 適用する TuneD プロファイル |
|
|
| klog ログの詳細度 |
4.1.3. .spec.config.tunedConfig
- 説明
- tuned-main.conf で定義されている TuneD デーモンのグローバル設定
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| TuneD デーモンの reapply_sysctl 機能のオン/オフ切り替え: true/false |
4.1.4. .spec.profile
- 説明
- Tuned プロファイル
- 型
-
array
4.1.5. .spec.profile[]
- 説明
- 調整されたプロファイル。
- 型
-
object - 必須
-
data -
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Tuned デーモンによって消費される Tuned プロファイルの仕様。 |
|
|
| 推奨セクションで使用される調整済みプロファイルの名前。 |
4.1.6. .status
- 説明
- ProfileStatus は、プロファイルリソースのステータスです。ステータスは内部使用のみであり、そのフィールドは将来変更/削除される可能性があります。
- 型
-
object - 必須
-
tunedProfile
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、ノードごとのプロファイルアプリケーションの状態を表します。 |
|
|
| StatusCondition は、ノードごとの Profile アプリケーションの部分的な状態を表します。 |
|
|
| 設定されている場合、これは conditions が設定された基準となる .metadata.generation を表します。 |
|
|
| Tuned デーモンによって使用されている現在のプロファイル |
4.1.7. .status.conditions
- 説明
- conditions は、ノードごとのプロファイルアプリケーションの状態を表します。
- 型
-
array
4.1.8. .status.conditions[]
- 説明
- StatusCondition は、ノードごとの Profile アプリケーションの部分的な状態を表します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、現在のステータスプロパティーが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。 |
|
|
| reason は、状態の現在のステータスの CamelCase の理由です。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| type は、この条件によって報告されるアスペクトを指定します。 |
4.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/tuned.openshift.io/v1/profiles-
GET: 種類が Profile のオブジェクトをリスト表示します。
-
/apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles-
DELETE: Profile のコレクションを削除します。 -
GET: 種類が Profile のオブジェクトをリスト表示します。 -
POST: Profile を作成します。
-
/apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}-
DELETE: Profile を削除します。 -
GET: 指定された Profile を読み取ります -
PATCH: 指定された Profile を部分的に更新します -
PUT: 指定された Profile を置き換えます
-
/apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}/status-
GET: 指定された Profile のステータスを読み取ります。 -
PATCH: 指定された Profile のステータスを部分的に更新します。 -
PUT: 指定された Profile のステータスを置き換えます。
-
4.2.1. /apis/tuned.openshift.io/v1/profiles
- HTTP メソッド
-
GET - 説明
- 種類が Profile のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
4.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles
- HTTP メソッド
-
DELETE - 説明
- Profile のコレクションを削除します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Profile のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- プロファイルの作成
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
4.2.3. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| プロファイルの名前。 |
- HTTP メソッド
-
DELETE - 説明
- プロファイルを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたプロファイルを読む
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたプロファイルを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたプロファイルを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
4.2.4. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}/status
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| プロファイルの名前。 |
- HTTP メソッド
-
GET - 説明
- 指定された Profile のステータスを読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Profile のステータスを部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Profile のステータスを置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第5章 RuntimeClass [node.k8s.io/v1]
- 説明
- RuntimeClass は、クラスターでサポートされるコンテナーランタイムのクラスを定義します。RuntimeClass は、Pod 内のすべてのコンテナーを実行するために使用されるコンテナーランタイムを決定するために使用されます。RuntimeClasses は、ユーザーまたはクラスタープロビジョナーによって手動で定義され、PodSpec で参照されます。Kubelet は、Pod を実行する前に RuntimeClassName 参照を解決する責任があります。詳細は、https://kubernetes.io/docs/concepts/containers/runtime-class/ を参照してください。
- 型
-
object - 必須
-
handler
-
5.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| handler は、CRI 実装がこのクラスの Pod を処理するために使用する基本的なランタイムと設定を指定します。可能な値は、ノードと CRI の設定に固有です。すべてのハンドラーがすべてのノードで使用可能であり、同じ名前のハンドラーがすべてのノードで同等であると想定されています。たとえば、"runc" というハンドラーは、runc OCI ランタイム (ネイティブ Linux コンテナーを使用) を使用して Pod 内のコンテナーを実行するように指定する場合があります。ハンドラーは小文字で、DNS ラベル (RFC 1123) 要件に準拠している必要があり、不変です。 |
|
|
| 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 | |
|
|
| オーバーヘッド構造は、Pod の実行に関連するリソースのオーバーヘッドを表します。 |
|
|
| スケジューリングは、RuntimeClass をサポートするノードのスケジューリング制約を指定します。 |
5.1.1. .overhead
- 説明
- オーバーヘッド構造は、Pod の実行に関連するリソースのオーバーヘッドを表します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| podFixed は、Pod の実行に関連する固定リソースのオーバーヘッドを表します。 |
5.1.2. .scheduling
- 説明
- スケジューリングは、RuntimeClass をサポートするノードのスケジューリング制約を指定します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| nodeSelector は、この RuntimeClass をサポートするノードに存在する必要があるラベルをリスト表示します。この RuntimeClass を使用する Pod は、このセレクターに一致するノードにのみスケジュールできます。RuntimeClass nodeSelector は、Pod の既存の nodeSelector とマージされます。競合があると、Pod は入場を拒否されます。 |
|
| アドミッション中にこの RuntimeClass で実行されている Pod に許容値が追加され (重複を除く)、Pod と RuntimeClass によって許容されるノードのセットが効果的に結合されます。 |
5.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/node.k8s.io/v1/runtimeclasses-
DELETE: RuntimeClass のコレクションを削除します。 -
GET: 種類が RuntimeClass のオブジェクトをリスト表示または監視します。 -
POST:RuntimeClass を作成します
-
/apis/node.k8s.io/v1/watch/runtimeclasses-
GET: RuntimeClass のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/node.k8s.io/v1/runtimeclasses/{name}-
DELETE: RuntimeClass を削除します -
GET: 指定された RuntimeClass を読み取ります -
PATCH: 指定された RuntimeClass を部分的に更新します -
PUT: 指定された RuntimeClass を置き換えます
-
/apis/node.k8s.io/v1/watch/runtimeclasses/{name}-
GET: 種類が RuntimeClass のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルタリングしてください。
-
5.2.1. /apis/node.k8s.io/v1/runtimeclasses
- HTTP メソッド
-
DELETE - 説明
- RuntimeClass のコレクションを削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が RuntimeClass のオブジェクトをリスト表示または監視します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- RuntimeClass を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
5.2.2. /apis/node.k8s.io/v1/watch/runtimeclasses
- HTTP メソッド
-
GET - 説明
- RuntimeClass のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
5.2.3. /apis/node.k8s.io/v1/runtimeclasses/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| RuntimeClass の名前 |
- HTTP メソッド
-
DELETE - 説明
- RuntimeClass を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された RuntimeClass を読み取ります
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された RuntimeClass を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された RuntimeClass を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
5.2.4. /apis/node.k8s.io/v1/watch/runtimeclasses/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| RuntimeClass の名前 |
- HTTP メソッド
-
GET - 説明
- 種類が RuntimeClass のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルタリングしてください。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第6章 Tuned [tuned.openshift.io/v1]
- 説明
- Tuned は、ノードレベルの sysctl をクラスター全体にデプロイし、ユーザーのニーズによって指定されたカスタムチューニングを追加するための柔軟性を高めるルールのコレクションです。これらのルールは変換され、デーモンが理解できる形式でクラスター内で実行されているすべてのコンテナー化された Tuned デーモンに渡されます。ノードレベルのチューニングを適用する責任は、コンテナー化された Tuned デーモンにあります。詳細: https://github.com/openshift/cluster-node-tuning-operator
- 型
-
object
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 は、Tuned の望ましい動作の仕様です。詳細: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status |
|
|
| TunedStatus は、Tuned リソースのステータスです。 |
6.1.1. .spec
- 説明
- spec は、Tuned の望ましい動作の仕様です。詳細: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| managementState は、この設定インスタンスによって表されるレジストリーインスタンスが Operator 管理下にあるかどうかを示します。有効な値は、Force、Managed、Unmanaged、および Removed です。 |
|
|
| Tuned プロファイル |
|
|
| 調整されたプロファイル。 |
|
|
| すべての調整済みプロファイルの選択ロジック。 |
|
|
| 単一の調整済みプロファイルの選択ロジック。 |
6.1.2. .spec.profile
- 説明
- Tuned プロファイル
- 型
-
array
6.1.3. .spec.profile[]
- 説明
- 調整されたプロファイル。
- 型
-
object - 必須
-
data -
name
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Tuned デーモンによって消費される Tuned プロファイルの仕様。 |
|
|
| 推奨セクションで使用される調整済みプロファイルの名前。 |
6.1.4. .spec.recommend
- 説明
- すべての調整済みプロファイルの選択ロジック。
- 型
-
array
6.1.5. .spec.recommend[]
- 説明
- 単一の調整済みプロファイルの選択ロジック。
- 型
-
object - 必須
-
priority -
profile
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| MachineConfigLabels は、MachineConfig のラベルを指定します。MachineConfig は、追加のホスト設定 (カーネルブートパラメーターなど) プロファイル 'Profile' のニーズを適用するために自動的に作成され、MachineConfig を作成することによってのみ適用できます。これには、MachineConfigLabels に一致する machineConfigSelector を持つすべての MachineConfigPools を検索し、MachineConfigPools の nodeSelectors に一致するすべてのノードにプロファイル 'Profile' を設定することが含まれます。 |
|
|
| 論理 OR Operator で接続された調整済みプロファイルの適用を管理するルール。 |
|
|
| 調整されたプロファイルの適用を管理するルール。 |
|
|
| オプションのオペランド設定。 |
|
|
| プロファイルの優先度を調整しました。最高の優先度は 0 です。 |
|
|
| 推奨する調整済みプロファイルの名前。 |
6.1.6. .spec.recommend[].match
- 説明
- 論理 OR Operator で接続された調整済みプロファイルの適用を管理するルール。
- 型
-
array
6.1.7. .spec.recommend[].match[]
- 説明
- 調整されたプロファイルの適用を管理するルール。
- 型
-
object - 必須
-
label
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ノードまたは Pod のラベル名。 |
|
|
| 論理 AND Operator で接続された調整済みプロファイルの適用を管理する追加のルール。 |
|
|
| マッチタイプ: [node/pod]。省略されている場合は、"node" が想定されます。 |
|
|
| ノードまたは Pod のラベル値。省略されている場合も、label name があるだけで一致条件を満たします。 |
6.1.8. .spec.recommend[].operand
- 説明
- オプションのオペランド設定。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| TuneD デーモンのデバッグのオン/オフ切り替え: true/false (デフォルトは false) |
|
|
| tuned-main.conf で定義されている TuneD デーモンのグローバル設定 |
|
|
| klog ログの詳細度 |
6.1.9. .spec.recommend[].operand.tunedConfig
- 説明
- tuned-main.conf で定義されている TuneD デーモンのグローバル設定
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| TuneD デーモンの reapply_sysctl 機能のオン/オフ切り替え: true/false |
6.1.10. .status
- 説明
- TunedStatus は、Tuned リソースのステータスです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| conditions は、Tuned プロファイルの状態を表します。 |
|
|
| StatusCondition は、ノードごとの Profile アプリケーションの部分的な状態を表します。 |
6.1.11. .status.conditions
- 説明
- conditions は、Tuned プロファイルの状態を表します。
- 型
-
array
6.1.12. .status.conditions[]
- 説明
- StatusCondition は、ノードごとの Profile アプリケーションの部分的な状態を表します。
- 型
-
object - 必須
-
lastTransitionTime -
status -
type
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、現在のステータスプロパティーが最後に更新された時刻です。 |
|
|
| message は、現在の状態に関する追加情報を提供します。これは人間によってのみ消費されます。 |
|
|
| reason は、状態の現在のステータスの CamelCase の理由です。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| type は、この条件によって報告されるアスペクトを指定します。 |
6.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/tuned.openshift.io/v1/tuneds-
GET: 種類が Tuned のオブジェクトをリスト表示します。
-
/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds-
DELETE: Tuned のコレクションを削除します。 -
GET: 種類が Tuned のオブジェクトをリスト表示します。 -
POST: 調整済みを作成します
-
/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}-
削除: 調整済みを削除します -
GET: 指定された Tuned を読み取ります -
PATCH: 指定された Tuned を部分的に更新します -
PUT: 指定された Tuned を置き換えます
-
/apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}/status-
GET: 指定された Tuned のステータスを読み取ります。 -
PATCH: 指定された Tuned のステータスを部分的に更新します。 -
PUT: 指定された Tuned のステータスを置き換えます。
-
6.2.1. /apis/tuned.openshift.io/v1/tuneds
- HTTP メソッド
-
GET - 説明
- 種類が Tuned のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
6.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds
- HTTP メソッド
-
DELETE - 説明
- Tuned のコレクションを削除します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Tuned のオブジェクトをリスト表示します。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- チューンドを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
6.2.3. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| チューンドの名前 |
- HTTP メソッド
-
DELETE - 説明
- 調整済みを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Tuned を読む
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Tuned を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Tuned を交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
6.2.4. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}/status
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| チューンドの名前 |
- HTTP メソッド
-
GET - 説明
- 指定された Tuned のステータスを読み取ります。
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Tuned のステータスを部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答のボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Tuned のステータスを置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}