ノード 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 |
|
| 指定した場合、ノードのテイント。 |
|
| このテイントが接続されているノードは、テイントを許容しない 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[]
- 説明
- このテイントが接続されているノードは、テイントを許容しない Pod に "影響" を及ぼします。
- 型
-
object
- 必須
-
key
-
effect
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 必須。テイントを許容しない Pod に対するテイントの影響。有効な効果は、NoSchedule、PreferNoSchedule、および NoExecute です。
使用可能な列挙値: - |
|
| 必須。ノードに適用されるテイントキー。 |
| TIME | TimeAdded は、テイントが追加された時刻を表します。NoExecute テイントにのみ作成されます。 |
|
| テイントキーに対応するテイント値。 |
2.1.6. .status
- 説明
- NodeStatus は、ノードの現在のステータスに関する情報です。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードに到達可能なアドレスのリスト。可能な場合は、クラウドプロバイダーから照会されます。詳細: https://kubernetes.io/docs/concepts/nodes/node/#addresses 注: このフィールドはマージ可能として宣言されていますが、マージキーは十分に一意ではないため、マージ時にデータが破損する可能性があります。代わりに、呼び出し元は完全置換パッチを使用する必要があります。例は、https://pr.k8s.io/79391 を参照してください。 |
|
| NodeAddress には、ノードのアドレスに関する情報が含まれています。 |
| Allocatable は、スケジューリングに使用できるノードのリソースを表します。デフォルトは容量です。 | |
| 容量は、ノードの合計リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
|
| 条件は、現在観測されているノード条件の配列です。詳細: https://kubernetes.io/docs/concepts/nodes/node/#condition |
|
| NodeCondition には、ノードの条件情報が含まれています。 |
|
| NodeConfigStatus は、Node.Spec.ConfigSource によって割り当てられた設定のステータスを記述します。 |
|
| NodeDaemonEndpoints は、ノードで実行されているデーモンによって開かれたポートをリスト表示します。 |
|
| このノードのコンテナーイメージのリスト |
|
| コンテナーのイメージを説明する |
|
| NodeSystemInfo は、ノードを一意に識別するための ID/UUID のセットです。 |
|
| NodePhase は、ノードの最近観察されたライフサイクルフェーズです。詳細: https://kubernetes.io/docs/concepts/nodes/node/#phase フィールドにデータが入力されることはなく、現在は非推奨になっています。
使用可能な列挙値: - |
|
| ノードに接続されているボリュームのリスト。 |
|
| AttachedVolume は、ノードに接続されているボリュームを表します |
|
| ノードによって使用中 (マウント済み) の接続可能なボリュームのリスト。 |
2.1.7. .status.addresses
- 説明
- ノードに到達可能なアドレスのリスト。可能な場合は、クラウドプロバイダーから照会されます。詳細: https://kubernetes.io/docs/concepts/nodes/node/#addresses 注: このフィールドはマージ可能として宣言されていますが、マージキーは十分に一意ではないため、マージ時にデータが破損する可能性があります。代わりに、呼び出し元は完全置換パッチを使用する必要があります。例は、https://pr.k8s.io/79391 を参照してください。
- 型
-
array
2.1.8. .status.addresses[]
- 説明
- NodeAddress には、ノードのアドレスに関する情報が含まれています。
- 型
-
object
- 必須
-
type
-
address
-
プロパティー | 型 | 説明 |
---|---|---|
|
| ノードアドレス。 |
|
| ノードアドレスタイプ。ホスト名、ExternalIP、または InternalIP のいずれか。 |
2.1.9. .status.conditions
- 説明
- 条件は、現在観測されているノード条件の配列です。詳細: https://kubernetes.io/docs/concepts/nodes/node/#condition
- 型
-
array
2.1.10. .status.conditions[]
- 説明
- NodeCondition には、ノードの条件情報が含まれています。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | 型 | 説明 |
---|---|---|
| TIME | 前回、特定の条件で更新を取得しました。 |
| TIME | 前回、状態が 1 つのステータスから別のステータスに移行したとき。 |
|
| 最後にある状態から別の状態に遷移した時間。 |
|
| (簡単な) 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| ノード条件のタイプ。 |
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.images
- 説明
- このノードのコンテナーイメージのリスト
- 型
-
array
2.1.21. .status.images[]
- 説明
- コンテナーのイメージを説明する
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| このイメージが知られている名前 (例: ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"])。 |
|
| イメージのサイズ (バイト単位)。 |
2.1.22. .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))。 |
|
| ノードによって報告された SystemUUID。一意のマシン識別には、MachineID が推奨されます。このフィールドは、Red Hat ホストに固有です https://access.redhat.com/documentation/ja-jp/red_hat_subscription_management/1/html/rhsm/uuid |
2.1.23. .status.volumesAttached
- 説明
- ノードに接続されているボリュームのリスト。
- 型
-
array
2.1.24. .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
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- Node のコレクションを削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
|
| 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 です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
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 | 空白 |
2.2.2. /api/v1/watch/nodes
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| 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 メソッド
-
GET
- 説明
- Node のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
2.2.3. /api/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
- 説明
- 指定されたノードを読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定されたノードを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
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 | 空白 |
2.2.4. /api/v1/watch/nodes/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ノードの名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| 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 メソッド
-
GET
- 説明
- ノードの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
2.2.5. /api/v1/nodes/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| ノードの名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定されたノードのステータスを読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定されたノードのステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
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章 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
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Addional カーネル引数。 |
|
| CPU は、CPU 関連のパラメーターのセットを定義します。 |
|
| GloballyDisableIrqLoadBalancing は、分離された CPU セットの IRQ 負荷分散を無効にするかどうかを切り替えます。オプションを "true" に設定すると、分離された CPU セットの IRQ 負荷分散が無効になります。オプションを "false" に設定すると、すべての CPU 間で IRQ を分散できます。ただし、irq-load-balancing.crio.io/cpu-quota.crio.io アノテーションを使用すると、Pod の CPU ごとに IRQ の負荷分散を無効にできます。デフォルトは "false" です。 |
|
| HugePages は、huge page に関連するパラメーターのセットを定義します。huge page には複数のサイズ値を同時に設定することが可能です。たとえば、hugepages は 1G と 2M に設定できます。どちらの値もパフォーマンスプロファイルコントローラーによってノードに設定されます。hugepages のデフォルトサイズを 1G に設定すると、ノードから 2M に関連するフォルダーがすべて削除され、ノードに 2M の hugepages を設定できなくなることに注意することが重要です。 |
|
| 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 のセットを定義します。 |
3.1.3. .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.4. .spec.hugepages.pages
- 説明
- Pages は、起動時に割り当てる huge page を定義します。
- 型
-
array
3.1.5. .spec.hugepages.pages[]
- 説明
- HugePage は、割り当てられる特定サイズの huge page の数を定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Count は、huge page の数を定義し、'hugepages' カーネルブートパラメーターにマップします。 |
|
| Node は、huge page を割り当てる NUMA ノードを定義します。指定されていない場合、ページは NUMA ノード間で均等に割り当てられます。 |
|
| Size は、huge page のサイズを定義し、'hugepagesz' カーネルブートパラメーターにマップします。 |
3.1.6. .spec.net
- 説明
- Net は、ネットワーク関連の機能のセットを定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Devices には、CPU.Reserved と等しい netqueue の数を使用して設定されるネットワークデバイス表現のリストを含めます。デバイスが指定されていない場合、デフォルトはすべてのデバイスです。 |
|
| Device は、デバイス名、ベンダー ID、モデル ID、PCI パス、MAC アドレスなど、いくつかのオプションでネットワークデバイスを表す方法を定義します。 |
|
| UserLevelNetworking を有効にすると、すべてのネットワークデバイスまたは指定されたネットワークデバイスのキューサイズが予約済み CPU の量に設定されます。デフォルトは "false" です。 |
3.1.7. .spec.net.devices
- 説明
- Devices には、CPU.Reserved と等しい netqueue の数を使用して設定されるネットワークデバイス表現のリストを含めます。デバイスが指定されていない場合、デフォルトはすべてのデバイスです。
- 型
-
array
3.1.8. .spec.net.devices[]
- 説明
- Device は、デバイス名、ベンダー ID、モデル ID、PCI パス、MAC アドレスなど、いくつかのオプションでネットワークデバイスを表す方法を定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 16 ビットの 16 進数として表されるネットワークデバイス ID (モデル)。 |
|
| 照合するネットワークデバイス名。正または負のシェルスタイルのワイルドカードの構文を使用します。 |
|
| 16 ビットの 16 進数として表されるネットワークデバイスベンダー ID。 |
3.1.9. .spec.numa
- 説明
- NUMA は、トポロジーを意識したアフィニティーに関連するオプションを定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| TopologyManager が有効な場合に適用されるポリシーの名前。Operator のデフォルトは "best-effort" です。 |
3.1.10. .spec.realTimeKernel
- 説明
- RealTimeKernel は、リアルタイムカーネル関連のパラメーターのセットを定義します。設定されていない場合、RT カーネルはインストールされません。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Enabled は、リアルタイムカーネルパッケージをインストールするかどうかを定義します。デフォルトは "false" です。 |
3.1.11. .spec.workloadHints
- 説明
- WorkloadHints は、さまざまな種類のワークロードのヒントを定義します。これにより、ノードに適用する必要があるチューニング済み引数とカーネル引数の正確なセットを定義できます。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| HighPowerConsumption は、ノードを高電力消費モードに設定するかどうかを定義します。このフラグは電力消費に影響しますが、CPU のレイテンシーが改善されます。 |
|
| PerPodPowerManagement は、ノードに Pod ごとの電源管理を設定する必要があるかどうかを定義します。PerPodPowerManagement ヒントと HighPowerConsumption ヒントを同時に有効にすることはできません。 |
|
| RealTime は、ノードをリアルタイムワークロード用に設定する必要があるかどうかを定義します。 |
3.1.12. .status
- 説明
- PerformanceProfileStatus は、PerformanceProfile の観測された状態を定義します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Conditions は、現在の状態として観察される最新の状態を表します。 |
|
| Condition は、Operator の調整機能の状態を表します。 |
|
| RuntimeClass には、Operator によって作成された RuntimeClass リソースの名前が含まれます。 |
|
| Tuned は、この Operator によって生成されたチューニング値を含む Tuned カスタムリソースオブジェクトを指します。 |
3.1.13. .status.conditions
- 説明
- Conditions は、現在の状態として観察される最新の状態を表します。
- 型
-
array
3.1.14. .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
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- PerformanceProfile のコレクションを削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| 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
- 説明
- 種類が PerformanceProfile のオブジェクトをリスト表示します。
パラメーター | 型 | 説明 |
---|---|---|
|
| 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
- 説明
- PerformanceProfile を作成します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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/performance.openshift.io/v2/performanceprofiles/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| PerformanceProfile の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- PerformanceProfile を削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された PerformanceProfile を読み取ります。
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された PerformanceProfile を部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された PerformanceProfile を置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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/performance.openshift.io/v2/performanceprofiles/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| PerformanceProfile の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された PerformanceProfile のステータスを読み取ります。
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された PerformanceProfile のステータスを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された PerformanceProfile のステータスを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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章 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
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
4.1.2. .spec.config
- 説明
- 型
-
object
- 必須
-
tunedProfile
-
プロパティー | 型 | 説明 |
---|---|---|
|
| TuneD デーモンの実行をデバッグするオプション |
|
| ノードの providerID から取得したクラウドプロバイダーの名前: <ProviderName>://<ProviderSpecificNodeID> |
|
| tuned-main.conf で定義されている TuneD デーモンのグローバル設定 |
|
| 適用する TuneD プロファイル |
4.1.3. .spec.config.tunedConfig
- 説明
- tuned-main.conf で定義されている TuneD デーモンのグローバル設定
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| TuneD デーモンの reapply_sysctl 機能のオン/オフ切り替え: true/false |
4.1.4. .status
- 説明
- ProfileStatus は、プロファイルリソースのステータスです。ステータスは内部使用のみであり、そのフィールドは将来変更/削除される可能性があります。
- 型
-
object
- 必須
-
tunedProfile
-
プロパティー | 型 | Description |
---|---|---|
|
| アクティブな Tuned プロファイル用にチューニングされたカーネルパラメーター。このフィールドは OBSOLETE であり、削除されます。OCPBUGS-19351 を参照してください。 |
|
| conditions は、ノードごとのプロファイルアプリケーションの状態を表します。 |
|
| ProfileStatusCondition は、ノードごとのプロファイルアプリケーションの部分的な状態を表します。 |
|
| Tuned デーモンによって使用されている現在のプロファイル |
4.1.5. .status.conditions
- 説明
- conditions は、ノードごとのプロファイルアプリケーションの状態を表します。
- 型
-
array
4.1.6. .status.conditions[]
- 説明
- ProfileStatusCondition は、ノードごとのプロファイルアプリケーションの部分的な状態を表します。
- 型
-
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
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| 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 メソッド
-
GET
- 説明
- 種類が Profile のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
4.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| '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 | 空白 |
4.2.3. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{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 | 空白 |
4.2.4. /apis/tuned.openshift.io/v1/namespaces/{namespace}/profiles/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| プロファイルの名前。 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された Profile のステータスを読み取ります。
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Profile のステータスを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された Profile のステータスを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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章 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 を参照してください。 |
|
| ハンドラーは、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}
-
削除
: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
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- RuntimeClass のコレクションを削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で、以前のクエリー結果からの continue 値のみを使用でき、サーバーは認識できない continue 値を拒否する可能性があります。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合は、続行フィールドなしでリストを再起動する必要があります。必要としない場合、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信できます。サーバーは次のキーから始まるリストで応答しますが、最新のスナップショットから取得するため、以前のリストの結果とは矛盾します。作成、変更、または削除されたオブジェクトは、キーが「次のキー」の後にある限り応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトは everything です。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクター。デフォルトは everything です。 |
|
| limit は、リスト呼び出しに対して返される応答の最大数です。他にもアイテムが存在する場合は、サーバーは、リストのメタデータ上の `continue` フィールドを、同じ初期クエリーで使用できる値に設定して、次の結果セットを取得します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしない場合もあり、その場合は利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、limit を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
|
| 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 です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類 RuntimeClass のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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
- 説明
- RuntimeClass を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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/node.k8s.io/v1/watch/runtimeclasses
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| 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 メソッド
-
GET
- 説明
- RuntimeClass のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
5.2.3. /apis/node.k8s.io/v1/runtimeclasses/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| RuntimeClass の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- RuntimeClass を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された RuntimeClass を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された RuntimeClass を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、`ServerSideFieldValidation` フィーチャーゲートも有効になっている場合に、不明または重複するフィールドを含む要求 (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは v1.23 以前のデフォルトの動作であり、`ServerSideFieldValidation` フィーチャーゲートが無効な場合のデフォルトの動作でもあります。警告: オブジェクトから削除された不明なフィールドと、検出された重複したフィールドごとに、標準の警告応答ヘッダーを介して警告を送ります。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは、`ServerSideFieldValidation` フィーチャーゲートが有効になっている場合のデフォルトです。Strict: オブジェクトから不明なフィールドが削除される場合、または重複するフィールドが存在する場合に、要求は BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された RuntimeClass を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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.4. /apis/node.k8s.io/v1/watch/runtimeclasses/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| RuntimeClass の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| 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 メソッド
-
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 デーモンのグローバル設定 |
6.1.9. .spec.recommend[].operand.tunedConfig
- 説明
- tuned-main.conf で定義されている TuneD デーモンのグローバル設定
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| TuneD デーモンの reapply_sysctl 機能のオン/オフ切り替え: true/false |
6.1.10. .status
- 説明
- TunedStatus は、Tuned リソースのステータスです。
- 型
-
object
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 を置き換えます
-
6.2.1. /apis/tuned.openshift.io/v1/tuneds
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 を使用して非常にサイズの大きい結果が小さめのチャンクに分けて受信することで、考えられるオブジェクトがすべて表示されるようにします。チャンクリスト中にオブジェクトが更新された場合は、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
|
| 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 メソッド
-
GET
- 説明
- 種類が Tuned のオブジェクトをリスト表示します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
6.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| '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 | 空白 |
6.2.3. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{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
- 説明
- 指定された Tuned を読む
パラメーター | 型 | 説明 |
---|---|---|
|
| resourceVersion は、要求を処理できるリソースのバージョンに関する制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 デフォルトは unset です。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Tuned を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された Tuned を交換してください
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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 | 空白 |
Legal Notice
Copyright © 2024 Red Hat, Inc.
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.