API リファレンス
MicroShift API リファレンス
概要
第1章 API 階層について
このガイダンスでは、階層化された MicroShift オファリングは説明しません。
Red Hat をお使いのアプリケーション開発者は、未特定の実装に特有の動作への依存や、特定の API 実装におけるバグへの依存を防ぐために、アプリケーション開発者が依存する動作が、API の公式ドキュメントで明示的に定義されていることを確認することが求められます。たとえば、Ingress ルーターの新しいリリースは、アプリケーションが文書化されていない API を使用するか、未定義の動作に依存している場合に、過去のリリースとは互換性がない場合があります。
1.1. API 階層
商用サポートされているすべての API、コンポーネント、および機能は、次のいずれかのサポートレベルに関連付けられています。
API 階層 1
API とアプリケーション動作環境 (AOE) は、メジャーリリースの期間内は安定性が確保されます。これらはメジャーリリース内で非推奨になる可能性があります。ただし、次のメジャーリリースまで削除されません。
API 階層 2
API と AOE は、メジャーリリース内で最低 9 か月間、または非推奨の発表から 3 つのマイナーリリースのいずれか長い方の期間は安定しています。
API 階層 3
このレベルは、Operator Hub を通じて MicroShift に含まれる言語、ツール、アプリケーション、およびオプションの Operator に適用されます。各コンポーネントは、API および AOE がサポートされるライフサイクルを指定します。言語ランタイム固有のコンポーネントの新しいバージョンは、マイナーバージョンからマイナーバージョンまで、API および AOE と可能な限り互換性を維持するように努めます。ただし、マイナーバージョン間の互換性は保証されません。
Operator Hub (Operator およびオペランドと呼ばれる) を介して継続的に更新を受け取るコンポーネントおよび開発ツールは、API 階層 3 とみなされます。開発者は注意を払い、これらのコンポーネントがマイナーリリースごとにどのように変化するかを理解する必要があります。コンポーネント別に文書化されている互換性ガイドラインを参照することが推奨されます。
API 階層 4
互換性は提供されません。API および AOE はいつでも変更できます。これらの機能は、長期サポートを必要とするアプリケーションで使用できません。
Operator がタスクを実行するためにカスタムリソース定義 (CRD) を内部で使用する方法は一般的な方法です。これらのオブジェクトは、Operator に含まれない外部アクターが使用するためのものではなく、非表示にすることを意図しています。Operator の外部のアクターが CRD を使用することを意図していない場合は、Operator ClusterServiceVersion
(CSV) の operators.operatorframework.io/internal-objects
アノテーションを指定して、対応するリソースが内部使用のみであることを通知する必要があります。また、CRD は、明示的に階層 4 としてラベル付けができます。
1.2. API 階層の API グループへのマッピング
Red Hat が定義した API 階層ごとに、アップストリームコミュニティーが上位互換性を維持することを約束している特定の API グループのマッピングテーブルを提供します。互換性レベルが明示的に指定されておらず、以下で具体的に説明されていない API グループには、デフォルトで階層 4 が割り当てられている v1alpha1
API を除き、デフォルトで API 階層 3 が割り当てられます。
1.2.1. Kubernetes API グループのサポート
接尾辞 *.k8s.io
で終わる、または接尾辞のないフォーム version.<name>
を持つ API グループは、Kubernetes の非推奨ポリシーによって管理され、特に指定がない限り、公開されている API バージョンと対応するサポート階層の間の一般的なマッピングに従います。
API バージョンの例 | API 階層 |
---|---|
| 階層 1 |
| 階層 2 |
| 階層 4 |
1.2.2. OpenShift API グループのサポート
接尾辞 *.openshift.io
で終わる API グループは、MicroShift の非推奨ポリシーによって管理され、特に指定がない限り、公開されている API バージョンと対応する互換性レベルの間の一般的なマッピングに従います。
API バージョンの例 | API 階層 |
---|---|
| 階層 1 |
|
|
1.3. API の非推奨ポリシー
MicroShift は、多くのアップストリームコミュニティーから提供された多くのコンポーネントで構成されています。コンポーネントのセット、関連する API インターフェイス、および相関する機能は時間の経過とともに進化し、機能を削除するために正式な非推奨が必要になる可能性があると予想されます。
1.3.1. API の一部の使用の終了
MicroShift は、一連の構造化された API を介して、複数のコンポーネントがクラスターコントロールプレーンによって管理される共有状態と相互作用する分散システムです。Kubernetes の規則に従って、MicroShift によって提示される各 API はグループ識別子に関連付けられ、各 API グループは個別にバージョン管理されます。各 API グループは、Kubernetes、Metal3、Multus、Operator Framework、Open Cluster Management、OpenShift 自体などを含む個別のアップストリームコミュニティーで管理されます。
各アップストリームコミュニティーは、特定の API グループおよびバージョンに対して固有の非推奨ポリシーを定義する場合がありますが、Red Hat はコミュニティー固有のポリシーを各アップストリームコミュニティーの統合と認識に基づいて定義された互換性レベルのいずれかに正規化し、エンドユーザーの消費やサポートを簡素化します。
API の非推奨ポリシーとスケジュールは、互換性レベルによって異なります。
非推奨ポリシーは、API のすべての要素を対象とします。以下に例を示します。
- API オブジェクトとしても知られる REST リソース
- REST リソースのフィールド
- バージョン固有の修飾子を除く、REST リソースのアノテーション
- 列挙値または定数値
各グループの最新の API バージョンを除き、古い API バージョンは、次の期間以上、非推奨が発表された後にサポートされる必要があります。
API 階層 | 期間 |
---|---|
階層 1 | メジャーリリース期間内は安定しています。これらはメジャーリリース内で非推奨になる可能性があります。ただし、次のメジャーリリースまで削除されません。 |
階層 2 | 非推奨の発表から 9 か月または 3 回のリリースのいずれか長い方。 |
階層 3 | コンポーネント固有のスケジュールを参照してください。 |
階層 4 | なし。互換性は保証されません。 |
次のルールは、すべての階層 1 API に適用されます。
- API 要素は、グループのバージョンをインクリメントすることによってのみ削除できます。
- API オブジェクトは、一部のバージョンに存在しない REST リソース全体を除いて、情報を失うことなく API バージョン間をラウンドトリップできるようにする必要があります。バージョン間に同等のフィールドが存在しない場合に、データは変換中にアノテーションの形式で保存されます。
- 特定のグループの API バージョンは、API オブジェクト全体が削除される場合を除いて、少なくとも安定した新しい API バージョンがリリースされるまで非推奨にすることはできません。
1.3.2. CLI 要素の廃止
クライアント向けの CLI コマンドは、API と同じ方法でバージョン管理されていませんが、ユーザー向けのコンポーネントシステムです。ユーザーが CLI を操作する 2 つの主な方法は、コマンドまたはフラグを使用することです。これは、このコンテキストでは CLI 要素と呼ばれます。
特に明記されていない限り、または CLI が下位層の API に依存している場合を除き、すべての CLI 要素はデフォルトで API 階層 1 になります。
要素 | API 階層 | |
---|---|---|
一般提供 (GA) | フラグおよびコマンド | 階層 1 |
テクノロジープレビュー | フラグおよびコマンド | 階層 3 |
開発者プレビュー | フラグおよびコマンド | 階層 4 |
1.3.3. コンポーネント全体の非推奨化
コンポーネント全体を非推奨にする期間とスケジュールは、そのコンポーネントが公開している API の最上位 API 層に関連付けられている期間に直接マップされます。たとえば、階層 1 と階層 2 の API を公開するコンポーネントは、階層 1 の非推奨スケジュールが満たされるまで削除できませんでした。
API 階層 | 期間 |
---|---|
階層 1 | メジャーリリース期間内は安定しています。これらはメジャーリリース内で非推奨になる可能性があります。ただし、次のメジャーリリースまで削除されません。 |
階層 2 | 非推奨の発表から 9 か月または 3 回のリリースのいずれか長い方。 |
階層 3 | コンポーネント固有のスケジュールを参照してください。 |
階層 4 | なし。互換性は保証されません。 |
第2章 API 互換性ガイドラインについて
MicroShift で有効な API を理解するには、互換性ガイドラインに従ってください。
このガイダンスでは、階層化された MicroShift オファリングは説明しません。
2.1. API 互換性ガイドライン
Red Hat では、MicroShift との互換性を改善するために、アプリケーション開発者が以下の原則を採用することを推奨しています。
- アプリケーションのニーズに一致するサポート層を備えた API とコンポーネントを使用します。
- 可能な場合は、公開されたクライアントライブラリーを使用してアプリケーションを構築します。
- アプリケーションは、実行対象として構築された環境と同じくらい新しい環境で実行される場合にのみ、正しく実行されることが保証されます。MicroShift 4.14 用にビルドされたアプリケーションは、MicroShift 4.13 で適切に機能することが保証されていません。
- システムパッケージまたは他のコンポーネントにより提供される設定ファイルに依存するアプリケーションを設計しないでください。アップストリームコミュニティーが、それを保存するように明示的にコミットしない限り、このファイルはバージョン間で変更する場合があります。必要に応じて、前方互換性を維持するために、この設定ファイルに対して Red Hat が提供するインターフェイス抽象化に依存します。設定ファイルを直接ファイルシステムで変更することは推奨しません。デュアルライターの競合を回避するために、利用可能な場合は、Operator が提供する API と統合することが強く推奨されます。
-
unsupported<FieldName>
の接頭辞が付いた API フィールドや、製品ドキュメントに明示的に記載されていないアノテーションに依存しないでください。 - お使いのアプリケーションより互換性の保証が短いコンポーネントには依存しないでください。
- etcd サーバーで直接ストレージ操作を実行しないでください。すべての etcd アクセスは、api-server を介して、または文書化されたバックアップと復元の手順を介して実行する必要があります。
Red Hat は、アプリケーション開発者が Red Hat Enterprise Linux (RHEL) によって定義された 互換性ガイドライン に従うことを推奨しています。MicroShift は、プラットフォーム上でアプリケーションを構築またはホストする際に、以下のガイドラインを強く推奨しています。
- 特定の Linux カーネルまたは MicroShift バージョンに依存しないでください。
-
proc
、sys
、およびdebug
ファイルシステム、または他の擬似ファイルシステムから読み込みは避けてください。 -
ioctls
は使用せず、ハードウェアと直接対話してください。 -
コンテナー実行環境を提供する MicroShift ホストエージェントと競合しないように、
cgroups
との直接的な対話は避けてください。
Red Hat は商業的に妥当な範囲で、リリースのライフサイクル全体で、すべてのマイナーリリースと z-stream リリースとの間で API とアプリケーション動作環境 (AOE) の互換性を維持するために努めます。ただし、必要に応じて、重大影響を及ぼすセキュリティー問題や、その他の重要な問題に対処するために、この互換性維持の目標に Red Hat が例外を設けることがあります。
2.2. API の互換性例外
以下は、MicroShift での互換性の例外になります。
アップグレードされたクラスターと新規インストールの間の機能のデフォルト
現時点では、製品のマイナーリリースの新規インストールが、以前のマイナーリリースでインストールされ、同等のバージョンにアップグレードされた製品のバージョンと同じ機能デフォルトになるという保証はありません。たとえば、製品の今後のバージョンでは、以前のマイナーバージョンとは異なるデフォルト設定で、クラウドインフラストラクチャーがプロビジョニングされる可能性があります。さらに、選択されていたセキュリティーに関するデフォルトの内容は、今後の製品バージョンと、過去の製品バージョンで異なる場合があります。製品の過去のバージョンはアップグレードされますが、特に下位互換性を維持するために、必要に応じて従来の選択肢が保持されます。
"unsupported” または undocumented annotations の接頭辞を持つ API フィールドの使用
製品で API を選択すると、unsupported<FieldName>
の接頭辞が付いたフィールドが公開されます。現時点では、このフィールドの使用がリリース間または同一リリース内でサポートされるという保証はありません。製品サポートは、特定の問題をデバッグする場合に、このフィールドで値を指定するようにお客様に依頼することはできますが、それ以外での使用はサポートされていません。明示的に文書化されていないオブジェクトでのアノテーションの使用に関しては、マイナーリリース間でのサポートは保証されていません。
製品インストールトポロジーごとの API の可用性
OpenShift ディストリビューションは、サポートされているインストールトポロジーを進化させ続け、あるインストールトポロジーのすべての API が必ずしも別のトポロジーに含まれるとは限りません。たとえば、特定のトポロジーでは、製品のインストールトポロジーと競合している場合、またはそのトポロジーに関連しておらず、特定の API がまったく含まれていない場合に、特定の API への読み取り/書き込みアクセスを制限できます。特定のトポロジーに存在する API は、上記で定義した互換性の階層に従ってサポートされます。
2.3. API の互換性の一般的な用語
2.3.1. アプリケーションプログラミングインターフェイス (API)
API は、他のソフトウェアとの対話を可能にするソフトウェアプログラムによって実装されるパブリックインターフェイスです。MicroShift では、API は中央の API サーバーから提供され、すべてのシステム対話のハブとして使用されます。
2.3.2. アプリケーション動作環境 (AOE)
AOE は、エンドユーザーアプリケーションプログラムを実行する統合環境です。AOE は、ホストオペレーティングシステム (OS) からの分離を提供するコンテナー化された環境です。少なくとも、AOE を使用すると、アプリケーションはホスト OS のライブラリーやバイナリーから分離された状態で実行できますが、ホスト上の他のすべてのコンテナーと同じ OS カーネルを共有できます。AOE はランタイム時に適用され、アプリケーションとそのオペレーティングシステム間のインターフェイスを記述します。これには、プラットフォーム、オペレーティングシステム、および環境間の交差点が含まれ、ユーザーアプリケーションには、Downward API、DNS、リソースアカウンティング、デバイスアクセス、プラットフォームワークロード ID、コンテナー間の分離、コンテナーとホスト OS との間の分離が含まれます。
AOE には、Container Network Interface (CNI) プラグインの選択や、アドミッションフックをはじめとした製品の拡張機能など、インストールにより異なる可能性のあるコンポーネントは含まれていません。コンテナー環境より下層のクラスターと統合するコンポーネントは、バージョン間で追加のバリエーションが適用される場合があります。
2.3.3. 仮想化環境における互換性
仮想環境は、ベアメタル環境で動作する非特権アプリケーションが、対応する仮想環境で変更されずに実行されるベアメタル環境をエミュレートします。仮想環境は、物理リソースが抽象化された簡易ビューを表示するため、相違点がいくつか存在する場合があります。
2.3.4. クラウド環境での互換性
MicroShift は、クラウドプロバイダー固有の統合を介してホスティングクラウド環境との統合ポイントを提供することを選択する場合があります。これらの統合ポイントの互換性は、ネイティブクラウドベンダーによって提供される保証と、MicroShift 互換性ウィンドウとの交差部分に固有のものです。MicroShift が、デフォルトのインストールの一部としてクラウド環境との統合をネイティブに提供する場合、Red Hat は安定したクラウド API エンドポイントに対して開発し、安定した非推奨ポリシーを含む将来を見据えた互換性を備えた商業的に合理的なサポートを提供します。クラウドプロバイダーと MicroShift の統合の例には、動的ボリュームプロビジョニング、サービスロードバランサー統合、Pod ワークロード ID、コンピューティングの動的管理、初期インストールの一部としてのプロビジョニングされるインフラストラクチャーが含まれますが、これらに限定されるものではありません。
2.3.5. メジャー、マイナー、および z-stream リリース
Red Hat メジャーリリースは、製品開発における重要なステップを表します。マイナーリリースは、メジャーリリースの範囲内でより頻繁に表示され、今後のアプリケーションの互換性に影響を与える可能性のある非推奨の境界を表します。z-stream リリースは、マイナーリリースへの更新で、関連するマイナーリリースに継続的な修正のストリームを提供します。予期しないセキュリティーの影響に対応するためにこのポリシーが明示的にオーバーライドされる場合を除いて、z-stream リリースで API と AOE の互換性が損なわれることはありません。
たとえば、リリース 4.13.2 では、以下のようになります。
- 4 は、メジャーリリースのバージョンです。
- 13 は、マイナーリリースのバージョンです。
- 2 は、z-stream リリースバージョンです。
2.3.6. 延長ユーザーサポート (EUS)
重大なバグ修正のためのサポート期間が延長された、MicroShift メジャーリリースのマイナーリリース。ユーザーは、EUS リリース間でマイナーバージョンを段階的に採用することにより、EUS リリース間で移行できます。非推奨のポリシーはマイナーリリース全体で定義され、EUS リリースではなく、留意することが重要です。その結果、EUS ユーザーは、各マイナーリリースを順次アップグレードしながら将来の EUS に移行するときに、非推奨に対応しなければならない場合があります。
2.3.7. 開発者プレビュー
Red Hat が正式にサポートしていないオプションの製品機能ですが、初期段階のテクノロジーを探索するメカニズムを提供することを目的としています。デフォルトでは、Developer Preview 機能はオプトインであり、いつでも削除される可能性があります。開発者プレビュー機能を有効にすると、機能のスコープによってクラスターがサポートされない可能性があります。
Red Hat のお客様またはパートナーで、こちらの開発者プレビューバージョンに関するフィードバックがある場合は、OpenShift Bugs tracker を使用して問題を報告してください。公式の Red Hat サポートサービスチケットプロセスを使用しないでください。サポート対応の詳細は、次の ナレッジアーティクル を参照してください。
2.3.8. テクノロジープレビュー
機能をテストし、開発プロセス中にフィードバックを提供するために、今後の製品イノベーションへの早期アクセスを提供するオプションの製品機能。この機能は完全にはサポートされておらず、機能的に完全ではない可能性があり、実稼働での使用を目的としていません。テクノロジープレビューの機能を使用するには、明示的なオプトインが必要です。テクノロジープレビュー機能のサポートスコープ の詳細をご覧ください。
第3章 API インデックス
API | API グループ |
---|---|
apiregistration.k8s.io/v1 | |
v1 | |
certificates.k8s.io/v1 | |
rbac.authorization.k8s.io/v1 | |
rbac.authorization.k8s.io/v1 | |
v1 | |
v1 | |
apps/v1 | |
batch/v1 | |
storage.k8s.io/v1 | |
storage.k8s.io/v1 | |
storage.k8s.io/v1 | |
apiextensions.k8s.io/v1 | |
apps/v1 | |
apps/v1 | |
v1 | |
discovery.k8s.io/v1 | |
v1 | |
events.k8s.io/v1 | |
policy/v1 | |
flowcontrol.apiserver.k8s.io/v1beta3 | |
autoscaling/v2 | |
networking.k8s.io/v1 | |
networking.k8s.io/v1 | |
batch/v1 | |
coordination.k8s.io/v1 | |
v1 | |
authorization.k8s.io/v1 | |
topolvm.io/v1 | |
admissionregistration.k8s.io/v1 | |
v1 | |
networking.k8s.io/v1 | |
v1 | |
v1 | |
v1 | |
v1 | |
policy/v1 | |
v1 | |
scheduling.k8s.io/v1 | |
flowcontrol.apiserver.k8s.io/v1beta3 | |
security.internal.openshift.io/v1 | |
apps/v1 | |
v1 | |
v1 | |
rbac.authorization.k8s.io/v1 | |
rbac.authorization.k8s.io/v1 | |
route.openshift.io/v1 | |
node.k8s.io/v1 | |
autoscaling/v1 | |
v1 | |
security.openshift.io/v1 | |
authorization.k8s.io/v1 | |
authorization.k8s.io/v1 | |
v1 | |
v1 | |
apps/v1 | |
storage.k8s.io/v1 | |
migration.k8s.io/v1alpha1 | |
authorization.k8s.io/v1 | |
authentication.k8s.io/v1 | |
authentication.k8s.io/v1 | |
admissionregistration.k8s.io/v1 | |
storage.k8s.io/v1 | |
snapshot.storage.k8s.io/v1 | |
snapshot.storage.k8s.io/v1 | |
snapshot.storage.k8s.io/v1 |
第4章 API オブジェクト参照
4.1. 共通のオブジェクト参照
4.1.1. io.k8s.api.admissionregistration.v1.MutatingWebhookConfigurationList スキーマ
- 説明
- MutatingWebhookConfigurationList は MutatingWebhookConfiguration のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| MutatingWebhookConfiguration のリスト。 | |
|
| 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#types-kinds を参照してください。 |
4.1.2. io.k8s.api.admissionregistration.v1.ValidatingWebhookConfigurationList スキーマ
- 説明
- ValidatingWebhookConfigurationList は ValidatingWebhookConfiguration のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| ValidatingWebhookConfiguration のリスト。 | |
|
| 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#types-kinds を参照してください。 |
4.1.3. io.k8s.api.apps.v1.ControllerRevisionList スキーマ
- 説明
- ControllerRevisionList は ControllerRevision オブジェクトのリストが含まれるリソースです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は ControllerRevisions のリストです。 | |
|
| 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 を参照してください。 |
4.1.4. io.k8s.api.apps.v1.DaemonSetList スキーマ
- 説明
- DaemonSetList はデーモンセットのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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 を参照してください。 |
4.1.5. io.k8s.api.apps.v1.DeploymentList スキーマ
- 説明
- DeploymentList は Deployments のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| 項目は Deployment のリストです。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準のリストメタデータ。 |
4.1.6. io.k8s.api.apps.v1.ReplicaSetList スキーマ
- 説明
- ReplicaSetList は ReplicaSet のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| ReplicaSet のリスト。詳細は、https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.7. io.k8s.api.apps.v1.StatefulSetList スキーマ
- 説明
- StatefulSetList は StatefulSets のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はステートフルセットのリストです。 | |
|
| 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 を参照してください。 |
4.1.8. io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList スキーマ
- 説明
- HorizontalPodAutoscalerList は Horizontal Pod Autoscaler オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は Horizontal Pod Autoscaler オブジェクトのリストです。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| metadata は標準のリストメタデータです。 |
4.1.9. io.k8s.api.batch.v1.CronJobList スキーマ
- 説明
- CronJobList は cron ジョブのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は CronJobs のリストです。 | |
|
| 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 を参照してください。 |
4.1.10. io.k8s.api.batch.v1.JobList スキーマ
- 説明
- JobList はジョブのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はジョブのリストです。 | |
|
| 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 を参照してください。 |
4.1.11. io.k8s.api.certificates.v1.CertificateSigningRequestList スキーマ
- 説明
- CertificateSigningRequestList は、CertificateSigningRequest オブジェクトのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は CertificateSigningRequest オブジェクトのコレクションです。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
4.1.12. io.k8s.api.coordination.v1.LeaseList スキーマ
- 説明
- LeaseList は Lease オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はスキーマオブジェクトのリストです。 | |
|
| 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 を参照してください。 |
4.1.13. io.k8s.api.core.v1.Affinity スキーマ
- 説明
- アフィニティーは、アフィニティースケジューリングルールのグループです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| Pod のノードアフィニティースケジューリングルールを説明します。 | |
| Pod アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置します)。 | |
| Pod の非アフィニティースケジューリングルールを説明します (たとえば、この Pod を他の Pod と同じノード、ゾーンなどに配置しないでください)。 |
4.1.14. io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource スキーマ
- 説明
AWS の永続ディスクリソースを表します。
AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
volumeID
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。 |
|
| readOnly 値 true は、VolumeMounts の readOnly 設定を強制的に実行します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
|
| volumeID は、AWS の永続ディスクリソースの一意の ID です (Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
4.1.15. io.k8s.api.core.v1.AzureDiskVolumeSource スキーマ
- 説明
- AzureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
- 型
-
object
- 必須
-
diskName
-
diskURI
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| cachingMode はホストキャッシュモードです (None, Read Only, Read Write)。
使用可能な列挙値: - |
|
| diskName は、Blob ストレージ内のデータディスクの名前です。 |
|
| diskURI は、Blob ストレージ内のデータディスクの URI です |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| kind での期待値は、Shared (ストレージアカウントごとに複数のブロブディスク)、Dedicated (ストレージアカウントごとにブロブ 1 つ)、Managed (Azure の管理データディスク (管理対象のアベイラビリティーセットのみ)) です。デフォルトは Shared です。
使用可能な列挙値:- |
|
| readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
4.1.16. io.k8s.api.core.v1.AzureFilePersistentVolumeSource スキーマ
- 説明
- AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
- 型
-
object
- 必須
-
secretName
-
shareName
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。 |
|
| secretNamespace は、Azure Storage Account Name および Key を含むシークレットの namespace で、デフォルトは Pod と同じです。 |
|
| shareName は Azure 共有名です。 |
4.1.17. io.k8s.api.core.v1.AzureFileVolumeSource スキーマ
- 説明
- AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
- 型
-
object
- 必須
-
secretName
-
shareName
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| secretName は、Azure ストレージアカウント名とキーを含むシークレットの名前です。 |
|
| shareName は Azure 共有名です。 |
4.1.18. io.k8s.api.core.v1.Capabilities スキーマ
- 説明
- 実行中のコンテナーに POSIX 機能を追加および削除します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 追加された機能 |
|
| 削除された機能 |
4.1.19. io.k8s.api.core.v1.CephFSPersistentVolumeSource スキーマ
- 説明
- Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
monitors
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
| secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | |
|
| user は任意: ユーザーは rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
4.1.20. io.k8s.api.core.v1.CephFSVolumeSource スキーマ
- 説明
- Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
monitors
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| monitors は必須: Monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| パスは任意: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは / です。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
|
| secretFile は任意: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
| secretRef は任意: SecretRef はユーザーの認証シークレットへの参照で、デフォルトは空です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it | |
|
| user 任意: User は rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it |
4.1.21. io.k8s.api.core.v1.CinderPersistentVolumeSource スキーマ
- 説明
- Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
volumeID
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| マウントする fsType ファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
| secretRef は任意:OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。 | |
|
| cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
4.1.22. io.k8s.api.core.v1.CinderVolumeSource スキーマ
- 説明
- Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
volumeID
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
| secretRef は任意: OpenStack への接続に使用されるパラメーターを含むシークレットオブジェクトを指します。 | |
|
| cinder 内のボリュームを識別するために使用される volumeID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md |
4.1.23. io.k8s.api.core.v1.ClaimSource スキーマ
- 説明
ClaimSource は、ResourceClaim への参照を記述します。
これらのフィールドのうち 1 つだけを設定する必要があります。このタイプのコンシューマーは、不明な値が含まれているように、空のオブジェクトを処理する必要があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ResourceClaimName は、この Pod と同じ namespace にある ResourceClaim オブジェクトの名前です。 |
|
| ResourceClaimTemplateName は、この Pod と同じ namespace にある ResourceClaimTemplate オブジェクトの名前です。 テンプレートは、この Pod にバインドされる新規 ResourceClaim の作成に使用されます。この Pod が削除されると、ResourceClaim も削除されます。ResourceClaim の名前は <pod name>-<resource name> になります。ここで、<resource name> は PodResourceClaim.Name です。連結された名前が ResourceClaim に対して有効でない (長すぎるなど) 場合は、Pod の検証で Pod が拒否されます。 Pod が所有していない名前が含まれる、既存の ResourceClaim は、無関係なリソースが誤って使用されることを避けるために、Pod では使用されません。スケジュールと Pod の起動は、関連のない ResourceClaim が削除されるまでブロックされます。 このフィールドは不変であり、ResourceClaim の作成後にコントロールプレーンによって対応する ResourceClaim に変更が加えられることはありません。 |
4.1.24. io.k8s.api.core.v1.ComponentStatusList スキーマ
- 説明
- ComponentStatus オブジェクトのリストとしてのコンポーネントのすべての条件のステータス。非推奨: この API は v1.19+ で非推奨となりました。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| ComponentStatus オブジェクトのリスト。 | |
|
| 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#types-kinds を参照してください。 |
4.1.25. io.k8s.api.core.v1.ConfigMapEnvSource スキーマ
- 説明
ConfigMapEnvSource は、環境変数に入力する ConfigMap を選択します。
ターゲットの ConfigMap のデータフィールドの内容は、キーと値のペアを環境変数として表します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| ConfigMap を定義する必要があるかどうかを指定します |
4.1.26. io.k8s.api.core.v1.ConfigMapKeySelector スキーマ
- 説明
- ConfigMap からキーを選択します。
- 型
-
object
- 必須
-
key
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 選択するキー。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
4.1.27. io.k8s.api.core.v1.ConfigMapList スキーマ
- 説明
- ConfigMapList は ConfigMap オブジェクトのリストが含まれるリソースです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は ConfigMap のリストです。 | |
|
| 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 を参照してください。 |
4.1.28. io.k8s.api.core.v1.ConfigMapProjection スキーマ
- 説明
ConfigMap をデプロイメントされたボリュームに適合させます。
項目要素にパスへのキーの特定のマッピングが入力されていない限り、ターゲットの ConfigMap のデータフィールドの内容は、データフィールドのキーをファイル名として使用してファイルとしてデプロイメントされるボリュームに表示されます。これは、デフォルトモードのない configmap ボリュームソースと同じであることに注意してください。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 | |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
4.1.29. io.k8s.api.core.v1.ConfigMapVolumeSource スキーマ
- 説明
ConfigMap をボリュームに適用します。
項目要素にパスへのキーの特定のマッピングが入力されていない限り、ターゲットの ConfigMap のデータフィールドの内容は、データフィールドのキーをファイル名として使用してファイルとしてボリュームに表示されます。ConfigMap ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
| item が指定されていない場合、参照される ConfigMap の Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。ConfigMap に存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 | |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 任意。ConfigMap かそのキーを定義する必要があるかどうかを指定します。 |
4.1.30. io.k8s.api.core.v1.Container スキーマ
- 説明
- Pod 内で実行する単一のアプリケーションコンテナー。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| エントリーポイントへの引数。これが指定されていない場合は、コンテナーイメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
| エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、コンテナーイメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| コンテナーに設定する環境変数のリスト。これを更新することはできません。 | |
| コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。 | |
|
| コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images このフィールドはオプションであり、高レベルの設定管理で、Deployments や StatefulSets などのワークロードコントローラーのコンテナーイメージをデフォルトまたはオーバーライドできます。 |
|
| イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images
使用可能な列挙値: - |
| コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクション。これを更新することはできません。 | |
| コンテナーの活性度の定期的な調査。プローブが失敗した場合、コンテナーは再起動されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | |
|
| DNS_LABEL として指定されたコンテナーの名前。Pod 内の各コンテナーには、一意の名前 (DNS_LABEL) が必要です。これを更新することはできません。 |
| コンテナーから公開するポートのリスト。ここでポートを指定しなくても、そのポートが公開されるのを防ぐことはできません。コンテナー内のデフォルトの "0.0.0.0" アドレスをリッスンしているポートは、ネットワークからアクセスできます。戦略的マージパッチを使用してこの配列を変更すると、データが破損する可能性があります。詳細は、https://github.com/kubernetes/kubernetes/issues/108255 を参照してください。これを更新することはできません。 | |
| コンテナーサービスの準備状況の定期的な調査。プローブが失敗すると、コンテナーはサービスエンドポイントから削除されます。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | |
| コンテナーのリソースサイズ変更ポリシー。 | |
| このコンテナーに必要なコンピューティングリソース。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ | |
| SecurityContext は、コンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ | |
| StartupProbe は、Pod が正常に初期化されたことを示します。指定した場合、これが正常に完了するまで、他のプローブは実行されません。このプローブが失敗すると、livenessProbe が失敗したかのように、Pod が再起動されます。これは、Pod のライフサイクルの開始時に、定常状態の操作中よりもデータのロードやキャッシュのウォームアップに長い時間がかかる可能性がある場合に、さまざまなプローブパラメーターを提供するために使用できます。これは更新できません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes | |
|
| このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。 |
|
| コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。 |
|
| オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。 |
|
| 終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。
使用可能な列挙値: - |
|
| このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。 |
| volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。 | |
| コンテナーのファイルシステムにマウントする Pod ボリューム。これを更新することはできません。 | |
|
| コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。 |
4.1.31. io.k8s.api.core.v1.ContainerPort スキーマ
- 説明
- ContainerPort は、単一のコンテナー内のネットワークポートを表します。
- 型
-
object
- 必須
-
containerPort
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| Pod の IP アドレスで公開するポートの数。これは有効なポート番号である必要があります、0<x<65536。 |
|
| 外部ポートをバインドするホスト IP。 |
|
| ホストで公開するポートの数。指定する場合、これは有効なポート番号、0<x<65536 である必要があります。HostNetwork が指定されている場合、これは ContainerPort と一致する必要があります。ほとんどのコンテナーはこれを必要としません。 |
|
| 指定する場合、これは IANA_SVC_NAME であり、Pod 内で一意である必要があります。Pod 内の名前付きポートにはそれぞれ一意の名前を付ける必要があります。サービスが参照できるポートの名前。 |
|
| ポートのプロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは "TCP" です。
使用可能な列挙値: - |
4.1.32. io.k8s.api.core.v1.ContainerResizePolicy スキーマ
- 説明
- ContainerResizePolicy は、コンテナーのリソースサイズ変更ポリシーを表します。
- 型
-
object
- 必須
-
resourceName
-
restartPolicy
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| このリソースサイズ変更ポリシーが適用されるリソースの名前。対応している値は、cpu、memory です。 |
|
| 指定されたリソースのサイズが変更されたときに適用する再起動ポリシー。指定しない場合、デフォルトの NotRequired が設定されます。 |
4.1.33. io.k8s.api.core.v1.CSIPersistentVolumeSource スキーマ
- 説明
- 外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)
- 型
-
object
- 必須
-
driver
-
volumeHandle
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| controllerExpandSecretRef は、CSI ControllerExpandVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットが渡されます。 | |
| controllerPublishSecretRef は、CSI ControllerPublish Volume および ControllerUnpublish Volume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットが渡されます。 | |
|
| driver は、このボリュームに使用するドライバーの名前です。必須。 |
|
| マウントする fsType。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。 |
| nodeExpandSecretRef は、CSI NodeExpandVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。これは、CSINodeExpandSecret フィーチャーゲートでデフォルトで有効になっているベータフィールドです。このフィールドは任意です。シークレットが不要な場合は省略できます。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットが渡されます。 | |
| nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットが渡されます。 | |
| nodeStageSecretRef は、CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照で、CSI NodeStageVolume および NodeStageVolume および NodeUnstageVolume 呼び出しを完了します。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットが渡されます。 | |
|
| ControllerPublishVolumeRequest に渡す readOnly の値。デフォルトは false (読み取り/書き込み) です。 |
|
| 公開するボリュームの volumeAttributes。 |
|
| volumeHandle は、CSI ボリュームプラグインの CreateVolume により返される一意のボリューム名であり、後続のすべての呼び出しでボリュームを参照します。必須。 |
4.1.34. io.k8s.api.core.v1.CSIVolumeSource スキーマ
- 説明
- 外部 CSI ドライバーによって管理される、マウントするボリュームのソースの場所を表します
- 型
-
object
- 必須
-
driver
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| driver は、このボリュームを処理する CSI ドライバーの名前です。クラスターに登録されている正しい名前は、管理者に相談してください。 |
|
| マウントする fsType。例: "ext4"、"xfs"、"ntfs"。指定しない場合、空の値が関連する CSI ドライバーに渡され、適用するデフォルトのファイルシステムが決定されます。 |
| nodePublishSecretRef は、CSI NodePublishVolume および NodeUnpublishVolume 呼び出しを完了するために CSI ドライバーに渡す機密情報を含むシークレットオブジェクトへの参照です。このフィールドはオプションであり、シークレットが不要な場合は空の場合があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレット参照が渡されます。 | |
|
| readOnly は、ボリュームの読み取り専用設定を指定します。デフォルトは false (読み取り/書き込み) です。 |
|
| volumeAttributes は、CSI ドライバーに渡されるドライバー固有のプロパティーを格納します。サポートされている値は、ドライバーのドキュメントを参照してください。 |
4.1.35. io.k8s.api.core.v1.DownwardAPIProjection スキーマ
- 説明
- デプロイメントされたボリュームにデプロイメントするための Downward API 情報を表します。これは、デフォルトモードのない downwardAPI ボリュームソースと同じであることに注意してください。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| Items は DownwardAPIVolume ファイルのリストです |
4.1.36. io.k8s.api.core.v1.DownwardAPIVolumeFile スキーマ
- 説明
- DownwardAPIVolumeFile は、Pod フィールドを含むファイルを作成するための情報を表します
- 型
-
object
- 必須
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| 必須:Pod のフィールドを選択します。アノテーション、ラベル、名前、namespace のみがサポートされます。 | |
|
| オプション: このファイルの権限を設定するために使用されるモードビットは、0000 から 0777 までの 8 進数値、または 0 から 511 までの 10 進数値でなければなりません。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| 必須: パスは、作成するファイルの相対パス名です。絶対パスまたは '..' パスを含めることはできません。utf-8 でエンコードする必要があります。相対パスの最初の項目は '..' で始まってはなりません。 |
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、requests.cpu、requests.memory) のみがサポートされています。 |
4.1.37. io.k8s.api.core.v1.DownwardAPIVolumeSource スキーマ
- 説明
- DownwardAPIVolumeSource は、Downward API 情報を含むボリュームを表します。Downward API ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| オプション: デフォルトで作成されたファイルで使用するモードビット。オプション: デフォルトで作成されたファイルのパーミッションを設定するために使用されるモードビット。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
| items は、Downward API ボリュームファイルのリストです |
4.1.38. io.k8s.api.core.v1.EmptyDirVolumeSource スキーマ
- 説明
- Pod の空のディレクトリーを表します。空のディレクトリーボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| medium は、このディレクトリーをバックアップする必要があるストレージメディアのタイプを表します。デフォルトは"" です。これは、ノードのデフォルトのメディアを使用することを意味します。空の文字列 (デフォルト) またはメモリーである必要があります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
| sizeLimit は、この EmptyDir ボリュームに必要なローカルストレージの合計量です。サイズ制限はメモリーメディアにも適用されます。メモリーメディア EmptyDir での最大使用量は、ここで指定された SizeLimit と Pod 内のすべてのコンテナーのメモリー制限の合計との間の最小値になります。デフォルトは nil です。これは、制限が未定義であることを意味します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
4.1.39. io.k8s.api.core.v1.EndpointsList スキーマ
- 説明
- EndpointsList はエンドポイントのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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#types-kinds を参照してください。 |
4.1.40. io.k8s.api.core.v1.EnvFromSource スキーマ
- 説明
- EnvFromSource は、一連の ConfigMap のソースを表します
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| 選択する ConfigMap | |
|
| ConfigMap の各キーの前に追加するオプションの識別子。C_IDENTIFIER でなければなりません。 |
| から選択する秘密 |
4.1.41. io.k8s.api.core.v1.EnvVar スキーマ
- 説明
- EnvVar は、コンテナーに存在する環境変数を表します。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 環境変数の名前。C_IDENTIFIER でなければなりません。 |
|
| 変数参照 $(VAR_NAME) は、コンテナー内で以前に定義された環境変数と任意のサービス環境変数を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。デフォルトは "" です。 |
| 環境変数の値のソースです。値が空でない場合は使用できません。 |
4.1.42. io.k8s.api.core.v1.EnvVarSource スキーマ
- 説明
- EnvVarSource は、EnvVar の値のソースを表します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| ConfigMap のキーを選択します。 | |
|
Pod のフィールドを選択します:metadata.name、metadata.namespace、 | |
| コンテナーのリソースを選択します。現在、リソースの制限とリクエスト (limits.cpu、limits.memory、limits.ephemeral-storage、requests.cpu、requests.memory、requests.ephemeral-storage) のみがサポートされています。 | |
| Pod の名前空間でシークレットのキーを選択します |
4.1.43. io.k8s.api.core.v1.EphemeralContainer スキーマ
- 説明
EphemeralContainer は、デバッグなど、ユーザーが開始したアクティビティーに対して、既存の Pod に追加できる一時コンテナーです。エフェメラルコンテナーにはリソースやスケジュールの保証がなく、コンテナーの終了時、または Pod の削除または再起動時に再起動されません。エフェメラルコンテナーが原因で Pod がリソース割り当てを超過した場合、kubelet は Pod をエビクトする可能性があります。
エフェメラルコンテナーを追加するには、既存の Pod の ephemeralcontainers サブリソースを使用します。エフェメラルコンテナーは削除または再起動できません。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| エントリーポイントへの引数。このプロパティが指定されていない場合は、イメージの CMD が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
|
| エントリーポイント配列。シェル内では実行されません。これが指定されていない場合は、イメージの ENTRYPOINT が使用されます。変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。変数を解決できない場合、入力文字列の参照は変更されません。Double は単一の $ に削減されます。これにより、$(VAR_NAME) 構文をエスケープできます。つまり、"(VAR_NAME)" は文字列リテラル "$(VAR_NAME)" を生成します。変数が存在するかどうかにかかわらず、エスケープされた参照は拡張されません。これを更新することはできません。詳細: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
| コンテナーに設定する環境変数のリスト。これを更新することはできません。 | |
| コンテナー内の環境変数に入力するソースのリスト。ソース内で定義されたキーは C_IDENTIFIER である必要があります。無効なキーはすべて、コンテナーの起動時にイベントとして報告されます。キーが複数のソースに存在する場合、最後のソースに関連付けられた値が優先されます。重複キーを持つ環境によって定義された値が優先されます。これを更新することはできません。 | |
|
| コンテナーイメージ名詳細: https://kubernetes.io/docs/concepts/containers/images |
|
| イメージプルポリシーAlways、Never、IfNotPresent のいずれか。デフォルトは、:latest タグが指定されている場合は常に、それ以外の場合は IfNotPresent です。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/containers/images#updating-images
使用可能な列挙値: - |
| エフェメラルコンテナーのライフサイクルは許可されていません。 | |
| 一時的なコンテナーにはプローブを使用できません。 | |
|
| DNS_LABEL として指定されたエフェメラルコンテナーの名前。この名前は、すべてのコンテナー、init コンテナー、およびエフェメラルコンテナーの中で一意である必要があります。 |
| エフェメラルコンテナーのポートは許可されていません。 | |
| 一時的なコンテナーにはプローブを使用できません。 | |
| コンテナーのリソースサイズ変更ポリシー。 | |
| エフェメラルコンテナーのリソースは許可されていません。エフェメラルコンテナーは、Pod にすでに割り当てられているスペアリソースを使用します。 | |
| オプション:SecurityContext は、エフェメラルコンテナーを実行する必要があるセキュリティーオプションを定義します。設定されている場合、SecurityContext のフィールドは PodSecurityContext の同等のフィールドをオーバーライドします。 | |
| 一時的なコンテナーにはプローブを使用できません。 | |
|
| このコンテナーがコンテナーランタイムで stdin にバッファーを割り当てる必要があるかどうか。これが設定されていない場合、コンテナー内の stdin からの読み取りは常に EOF になります。デフォルトは false です。 |
|
| コンテナーランタイムが、単一の接続によって開かれた後に stdin チャネルを閉じる必要があるかどうか。stdin が true の場合、stdin ストリームは複数の接続セッションにわたって開いたままになります。stdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin に接続するまで空になり、クライアントが切断されるまで開いたままでデータを受け入れます。切断されると、stdin は閉じられ、コンテナーが再起動されるまで閉じられたままになります。。このフラグが false の場合、stdin から読み取るコンテナープロセスは EOF を受信しません。デフォルトは false です。 |
|
| 設定されている場合、このエフェメラルコンテナーがターゲットとする PodSpec からのコンテナーの名前。エフェメラルコンテナーは、このコンテナーの namespace (IPC、PID など) で実行されます。設定されていない場合、エフェメラルコンテナーは Pod 仕様で設定された namespace を使用します。 コンテナーランタイムは、この機能のサポートを実装する必要があります。ランタイムが namespace ターゲットをサポートしていない場合、このフィールドの設定結果は定義されません。 |
|
| オプション: コンテナーの終了メッセージが書き込まれるファイルがコンテナーのファイルシステムにマウントされるパス。書き込まれるメッセージは、アサーション失敗メッセージなどの簡単な最終ステータスを目的としています。4096 バイトを超える場合、ノードによって切り捨てられます。すべてのコンテナーの合計メッセージ長は 12kb に制限されます。デフォルトは/dev/termination-log です。これを更新することはできません。 |
|
| 終了メッセージの入力方法を示します。ファイルは、terminationMessagePath の内容を使用して、成功と失敗の両方でコンテナーステータスメッセージを入力します。終了メッセージファイルが空で、コンテナーがエラーで終了した場合、FallbackToLogsOnError はコンテナーログ出力の最後のチャンクを使用します。ログ出力は、2048 バイトまたは 80 行のいずれか小さい方に制限されます。デフォルトは File です。これを更新することはできません。
使用可能な列挙値: - |
|
| このコンテナーがそれ自体に TTY を割り当てる必要があるかどうかには、'stdin' が true である必要もあります。デフォルトは false です。 |
| volumeDevices は、コンテナーによって使用されるブロックデバイスのリストです。 | |
| コンテナーのファイルシステムにマウントする Pod ボリューム。エフェメラルコンテナーでは、サブパスをマウントできません。これを更新することはできません。 | |
|
| コンテナーの作業ディレクトリー。指定しない場合、コンテナーランタイムのデフォルトが使用されます。これは、コンテナーイメージで設定されている可能性があります。これを更新することはできません。 |
4.1.44. io.k8s.api.core.v1.EphemeralVolumeSource スキーマ
- 説明
- 通常のストレージドライバーによって処理される一時的なボリュームを表します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
ボリュームをプロビジョニングするためのスタンドアロン PVC を作成するために使用されます。この EphemeralVolumeSource が埋め込まれている Pod が PVC の所有者になります。つまり、PVC は Pod と一緒に削除されます。PVC の名前は Pod が所有していないその名前の既存の PVC は、無関係なボリュームを誤って使用することを避けるために、Pod に使用され ません。Pod の起動は、無関係の PVC が削除されるまでブロックされます。そのような事前に作成された PVC が Pod で使用されることを意図している場合、Pod が存在すると、PVC は Pod への所有者参照で更新する必要があります。通常、これは必要ありませんが、壊れたクラスターを手動で再構築する場合に役立つことがあります。 このフィールドは読み取り専用であり、作成後に Kubernetes が PVC に変更を加えることはありません。 必須です。nil であってはなりません。 |
4.1.45. io.k8s.api.core.v1.EventList スキーマ
- 説明
- EventList はイベントのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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#types-kinds を参照してください。 |
4.1.46. io.k8s.api.core.v1.EventSource スキーマ
- 説明
- EventSource にはイベントの情報が含まれます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| イベントの生成元となるコンポーネント。 |
|
| イベントが生成されるノード名。 |
4.1.47. io.k8s.api.core.v1.ExecAction スキーマ
- 説明
- ExecAction は、"run in container" アクションを記述します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| コマンドはコンテナー内で実行するコマンドラインであり、コマンドの作業ディレクトリーはコンテナーのファイルシステムのルート ('/') です。コマンドは単純に実行され、シェル内では実行されないため、従来のシェル命令 ('|' など) は機能しません。シェルを使用するには、そのシェルを明示的に呼び出す必要があります。終了ステータス 0 はライブ/正常として扱われ、ゼロ以外は異常として扱われます。 |
4.1.48. io.k8s.api.core.v1.FCVolumeSource スキーマ
- 説明
- ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| LUN は任意: FC ターゲットの LUN 番号 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| targetWWNs は任意: FC ターゲットのワールドワイド名 (WWN) |
|
| wwids は任意: FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定できません。 |
4.1.49. io.k8s.api.core.v1.FlexPersistentVolumeSource スキーマ
- 説明
- FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。
- 型
-
object
- 必須
-
driver
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| driver は、このボリュームに使用するドライバーの名前です。 |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。 |
|
| options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
| secretRef は任意: SecretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。 |
4.1.50. io.k8s.api.core.v1.FlexVolumeSource スキーマ
- 説明
- FlexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。
- 型
-
object
- 必須
-
driver
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| driver は、このボリュームに使用するドライバーの名前です。 |
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。 |
|
| options は任意: このフィールドには追加のコマンドオプションがあれば保持されます。 |
|
| readOnly は任意: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
| secretRef は任意: secretRef は、プラグインスクリプトに渡す機密情報を含むシークレットオブジェクトへの参照です。シークレットオブジェクトが指定されていない場合、これは空になる可能性があります。シークレットオブジェクトに複数のシークレットが含まれている場合、すべてのシークレットがプラグインスクリプトに渡されます。 |
4.1.51. io.k8s.api.core.v1.FlockerVolumeSource スキーマ
- 説明
- Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| datasetName はメタデータとして保存されているデータセットの名前です → Flocker のデータセット上の名前は非推奨として扱うようにしてください。 |
|
| datasetUUID は、データセットの UUID です。これは Flocker データセットの一意の識別子です |
4.1.52. io.k8s.api.core.v1.GCEPersistentDiskVolumeSource スキーマ
- 説明
Google Compute Engine の永続ディスクリソースを表します。
GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
pdName
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| partition は、マウントするボリューム内のパーティションです。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを "1" として指定します。同様に、/dev/sda のボリュームパーティションは "0" です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| pdName は、GCE の PD リソースの一意の名前です。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
4.1.53. io.k8s.api.core.v1.GitRepoVolumeSource スキーマ
- 説明
git リポジトリーのコンテンツが入力されているボリュームを表します。Git リポジトリーボリュームは所有権管理をサポートしていません。Git リポジトリーボリュームは SELinux の再ラベル付けをサポートしています。
非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。
- 型
-
object
- 必須
-
repository
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| directory は、ターゲットディレクトリー名です。'..' を含まない、または..で始まらないようにする必要があります。もしも '。' が提供されている場合、ボリュームディレクトリーは git リポジトリーになります。それ以外の場合、指定されている場合、ボリュームには、指定された名前のサブディレクトリーに git リポジトリーが含まれます。 |
|
| repository は URL です。 |
|
| revision は、指定されたリビジョンのコミットハッシュです。 |
4.1.54. io.k8s.api.core.v1.GlusterfsPersistentVolumeSource スキーマ
- 説明
- Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
endpoints
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| endpointsNamespace は、Glusterfs エンドポイントを含む namespace です。このフィールドが空の場合、EndpointNamespace はデフォルトでバインドされた PVC と同じ namespace になります。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
4.1.55. io.k8s.api.core.v1.GlusterfsVolumeSource スキーマ
- 説明
- Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
endpoints
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| endpoints は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| path は Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
|
| この readOnly は、Glusterfs ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod |
4.1.56. io.k8s.api.core.v1.GRPCAction スキーマ
- 説明
- 型
-
object
- 必須
-
port
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| gRPC サービスのポート番号。番号は 1〜65535 の範囲である必要があります。 |
|
| Service は、gRPC HealthCheckRequest に配置するサービスの名前です (https://github.com/grpc/grpc/blob/master/doc/health-checking.md を参照)。 これが指定されていない場合、デフォルトの動作は gRPC によって定義されます。 |
4.1.57. io.k8s.api.core.v1.HostAlias スキーマ
- 説明
- HostAlias は、Pod の hosts ファイルのエントリーとして挿入される IP とホスト名の間のマッピングを保持します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 上記の IP アドレスのホスト名。 |
|
| ホストファイルエントリーの IP アドレス。 |
4.1.58. io.k8s.api.core.v1.HostPathVolumeSource スキーマ
- 説明
- Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
|
| HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
使用可能な列挙値: - |
4.1.59. io.k8s.api.core.v1.HTTPGetAction スキーマ
- 説明
- HTTPGetAction は、HTTP GET リクエストに基づくアクションを記述します。
- 型
-
object
- 必須
-
port
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 接続するホスト名。デフォルトは Pod IP です。代わりに、httpHeaders で "ホスト" を設定することを推奨します。 |
| リクエストに設定するカスタムヘッダー。HTTP ではヘッダーを繰り返すことができます。 | |
|
| HTTP サーバーでアクセスするパス。 |
| コンテナーでアクセスするポートの名前または番号。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 | |
|
| ホストへの接続に使用するスキーム。デフォルトは HTTP です。
使用可能な列挙値: - |
4.1.60. io.k8s.api.core.v1.HTTPHeader スキーマ
- 説明
- HTTPHeader は、HTTP プローブで使用されるカスタムヘッダーを記述します
- 型
-
object
- 必須
-
name
-
value
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ヘッダーフィールド名。これは出力時に正規化されるため、大文字/小文字の名前は同じヘッダーとして認識されます。 |
|
| ヘッダーフィールド値 |
4.1.61. io.k8s.api.core.v1.ISCSIPersistentVolumeSource スキーマ
- 説明
- ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
targetPortal
-
iqn
-
lun
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。 |
|
| chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。 |
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
| initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。 |
|
| IQN は、ターゲット iSCSI 修飾名です。 |
|
| iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。 |
|
| LUN は iSCSI ターゲット Lun 番号です。 |
|
| ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。 |
| secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。 | |
|
| targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
4.1.62. io.k8s.api.core.v1.ISCSIVolumeSource スキーマ
- 説明
- ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
targetPortal
-
iqn
-
lun
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| chapAuthDiscovery は、iSCSI 検出 CHAP 認証をサポートするかどうかを定義します。 |
|
| chapAuthSession は、iSCSI セッション CHAP 認証をサポートするかどうかを定義します。 |
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi |
|
| initiatorName は、カスタムの iSCSI イニシエーター名です。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス <target portal>:<volume name> が作成されます。 |
|
| iqn は、ターゲットの iSCSI 修飾名です。 |
|
| iscsiInterface は、iSCSI トランスポートを使用するインターフェイス名です。デフォルトは 'default' (tcp) です。 |
|
| lun は、iSCSI ターゲット Lun 番号を表します。 |
|
| ポータルは iSCSI ターゲットポータルリストです。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。 |
| secretRef は、iSCSI ターゲットおよびイニシエーター認証用の CHAP Secret です。 | |
|
| targetPortal は iSCSI Target Portal です。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。 |
4.1.63. io.k8s.api.core.v1.KeyToPath スキーマ
- 説明
- 文字列キーをボリューム内のパスにマップします。
- 型
-
object
- 必須
-
key
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| key はプロジェクトのキーです。 |
|
| mode は任意: このファイルにアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。指定しない場合、ボリューム defaultMode が使用されます。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
|
| path はキーをマップするファイルの相対パスです。絶対的なパスではない可能性があります。パス要素 '..' を含めることはできません。文字列 '..' で始まらない場合があります。 |
4.1.64. io.k8s.api.core.v1.Lifecycle スキーマ
- 説明
- ライフサイクルは、コンテナーのライフサイクルイベントに対応して管理システムが実行する必要のあるアクションを表します。PostStart および PreStop ライフサイクルハンドラーの場合、コンテナープロセスが失敗しない限り、アクションが完了するまでコンテナー管理がブロックされます。失敗した場合、ハンドラーは中止されます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| PostStart は、コンテナーが作成された直後に呼び出されます。ハンドラーに障害が発生した場合、コンテナーは終了し、再始動ポリシーに従って再始動されます。フックが完了するまでのコンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks | |
| PreStop は、API リクエスト、または活性/起動プローブの失敗、プリエンプション、リソース競合などの管理イベントが原因でコンテナーが終了する直前に呼び出されます。コンテナーがクラッシュまたは終了した場合、ハンドラーは呼び出されません。Pod の終了猶予期間のカウントダウンは、PreStop フックが実行される前に開始されます。ハンドラーの結果に関係なく、コンテナーは最終的に Pod の終了猶予期間内に終了します (ファイナライザーによって遅延されない限り)。フックが完了するまで、または終了猶予期間に達するまで、コンテナーブロックの他の管理。詳細: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks |
4.1.65. io.k8s.api.core.v1.LifecycleHandler スキーマ
- 説明
- LifecycleHandler は、ライフサイクルフックで実行する必要がある特定のアクションを定義します。TCPSocket を除くフィールドのうち 1 つだけを指定する必要があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| Exec は実行するアクションを指定します。 | |
| HTTPGet は、実行する http リクエストを指定します。 | |
| 非推奨。TCPSocket は LifecycleHandler としてサポートされておらず、後方互換性を確保するために保持されています。このフィールドは検証されず、tcp ハンドラーが指定されている場合、ライフサイクルフックは実行時に失敗します。 |
4.1.66. io.k8s.api.core.v1.LimitRangeList スキーマ
- 説明
- LimitRangeList は LimitRange 項目のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は LimitRange オブジェクトのリストです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.67. io.k8s.api.core.v1.LocalObjectReference スキーマ
- 説明
- LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
4.1.68. io.k8s.api.core.v1.LocalVolumeSource スキーマ
- 説明
- Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)
- 型
-
object
- 必須
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。Path がブロックデバイスの場合にのみ適用されます。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルト値は、指定されていないと、ファイルシステムを自動選択します。 |
|
| ノード上のボリュームへのフルパス。これは、ディレクトリーまたはブロックデバイス (ディスク、パーティションなど) のいずれかです。 |
4.1.69. io.k8s.api.core.v1.NamespaceList スキーマ
- 説明
- NamespaceList は namespace のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は、リストの Namespace オブジェクトのリストです。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ | |
|
| 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#types-kinds を参照してください。 |
4.1.70. io.k8s.api.core.v1.NFSVolumeSource スキーマ
- 説明
- Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
server
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| ここで readOnly を指定すると、NFS エクスポートが読み取り専用権限で強制的にマウントされます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
|
| server は、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
4.1.71. io.k8s.api.core.v1.NodeAffinity スキーマ
- 説明
- ノードアフィニティーは、ノードアフィニティースケジューリングルールのグループです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードが対応する matchExpressions と一致する場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 | |
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。 |
4.1.72. io.k8s.api.core.v1.NodeList スキーマ
- 説明
- NodeList は、マスターで登録されているすべてのノードの全リストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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#types-kinds を参照してください。 |
4.1.73. io.k8s.api.core.v1.NodeSelector スキーマ
- 説明
- ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。
- 型
-
object
- 必須
-
nodeSelectorTerms
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| 必須。ノードセレクター用語のリスト。用語は OR されています。 |
4.1.74. io.k8s.api.core.v1.NodeSelectorRequirement スキーマ
- 説明
- ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。
使用可能な列挙値: - |
|
| 文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
4.1.75. io.k8s.api.core.v1.NodeSelectorTerm スキーマ
- 説明
- null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| ノードのラベルごとのノードセレクター要件のリスト。 | |
| ノードのフィールドごとのノードセレクター要件のリスト。 |
4.1.76. io.k8s.api.core.v1.ObjectFieldSelector スキーマ
- 説明
- ObjectFieldSelector は、オブジェクトの APIVersioned フィールドを選択します。
- 型
-
object
- 必須
-
fieldPath
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| FieldPath が記述されているスキーマのバージョン。デフォルトは "v1" です。 |
|
| 指定された API バージョンで選択するフィールドのパス。 |
4.1.77. io.k8s.api.core.v1.ObjectReference スキーマ
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
4.1.78. io.k8s.api.core.v1.PersistentVolumeClaim スキーマ
- 説明
- PersistentVolumeClaim は、永続ボリュームに対するユーザーの要求および要求です。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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 を参照してください。 | |
|
| PersistentVolumeClaimSpec は、ストレージデバイスの一般的な属性を記述し、プロバイダー固有の属性のソースを許可します |
|
| PersistentVolumeClaimStatus は永続ボリューム要求の現在のステータスです。 |
..spec Description::
+
PersistentVolumeClaimSpec は、ストレージデバイスの一般的な属性を記述し、プロバイダー固有の属性のソースを許可します
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
|
| TypedLocalObjectReference には、同じ namespace 内で typed 参照オブジェクトを見つけるのに十分な情報が含まれます。 |
|
| dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
|
| ResourceRequirements は、コンピュートリソースの要件を説明します。 |
| selector は、バインドを考慮するボリュームに対するラベルクエリーです。 | |
|
| storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
| volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。
使用可能な列挙値: - |
|
| volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。 |
..spec.dataSource Description::
+
TypedLocalObjectReference には、同じ namespace 内で typed 参照オブジェクトを見つけるのに十分な情報が含まれます。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
..spec.dataSourceRef Description::
+
dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
|
| Namespace は、参照されるリソースの namespace です。namespace が指定されている場合は、その namespace の所有者が参照を受け入れることができるように、参照された namespace に gateway.networking.k8s.io/ReferenceGrant オブジェクトが必要であることに注意してください。詳細は、ReferenceGrant ドキュメントを参照してください。(アルファ版) このフィールドでは、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
..spec.resources Description::
+
ResourceRequirements は、コンピュートリソースの要件を説明します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。 これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。 このフィールドは不変です。これはコンテナーにのみ設定できます。 |
|
| ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。 |
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 | |
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
..spec.resources.claims Description::
+
Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。
これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。
このフィールドは不変です。これはコンテナーにのみ設定できます。
- 型
-
array
..spec.resources.claims[] Description::
+
ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。 |
..status Description::
+
PersistentVolumeClaimStatus は永続ボリューム要求の現在のステータスです。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| accessModes には、PVC をサポートするボリュームが実際に持つアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
| allocatedResources は、AllocatedResources 内のストレージリソースで、PVC に割り当てられた容量を追跡します。ボリューム拡張操作が要求された場合、実際の容量よりも大きくなる場合があります。ストレージクォータには、allocatedResources と PVC.spec.resources を比較して大きい方の値が使用されます。allocatedResources が設定されていない場合、PVC.spec.resources のみがクォータの計算に使用されます。ボリューム拡張容量要求が下げられ、進行中の拡張操作がなく、実際のボリューム容量が要求された容量以下である場合にのみ、allocatedResources が引き下げられます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。 | |
| capacity は、基礎となるボリュームの実際のリソースを表します。 | |
|
| conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。 |
|
| PersistentVolumeClaimCondition には PVC の状態に関する詳細が含まれています。 |
|
| phase は PersistentVolumeClaim の現在のフェーズを表します。
使用可能な列挙値: - |
|
| resizeStatus は、サイズ変更操作のステータスを格納します。ResizeStatus はデフォルトでは設定されませんが、拡張が完了すると、サイズ変更コントローラーまたは kubelet によって、resizeStatus が空の文字列に設定されます。これはアルファフィールドであるため、RecoverVolumeExpansionFailure 機能を有効にする必要があります。
使用可能な列挙値: - |
..status.conditions Description::
+
conditions は永続ボリューム要求の現在の条件です。基礎となる永続ボリュームのサイズを変更すると、Condition は 'ResizeStarted' に設定されます。
- 型
-
array
..status.conditions[] Description::
+
PersistentVolumeClaimCondition には PVC の状態に関する詳細が含まれています。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| lastProbeTime は、条件を調査した時間です。 | |
| lastTransitionTime は、条件があるステータスから別のステータスに遷移した最後の時間です。 | |
|
| message は、最後の遷移に関する詳細を示し、人間が判読できるメッセージです。 |
|
| 一意であり、これは、条件の最後の遷移理由を示す、マシンが理解できる短い文字列である必要があります。"ResizeStarted" と報告された場合は、基礎となる永続ボリュームのサイズが変更されていることを意味します。 |
|
| |
|
|
4.1.79. io.k8s.api.core.v1.PersistentVolumeClaimList スキーマ
- 説明
- PersistentVolumeClaimList は PersistentVolumeClaim アイテムのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は永続ボリューム要求のリストです。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | |
|
| 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#types-kinds を参照してください。 |
4.1.80. io.k8s.api.core.v1.PersistentVolumeClaimSpec スキーマ
- 説明
- PersistentVolumeClaimSpec は、ストレージデバイスの一般的な属性を記述し、プロバイダー固有の属性のソースを許可します
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| accessModes には、ボリュームに割り当てる必要のあるアクセスモードが含まれます。詳細は、https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 を参照してください。 |
| dataSource フィールドは、次のいずれかを指定するために使用できます。*既存の VolumeSnapshot オブジェクト (snapshot.storage.k8s.io/VolumeSnapshot)*既存の PVC(PersistentVolumeClaim) プロビジョナーまたは外部コントローラーが指定されたデータソースをサポートできる場合、指定されたデータソースのコンテンツに基づく新しいボリューム。AnyVolumeDataSource フィーチャーゲートが有効になっている場合、dataSource の内容は dataSourceRef にコピーされ、dataSourceRef.namespace が指定されていない場合に dataSourceRef コンテンツが dataSource にコピーされます。namespace が指定されている場合、dataSourceRef は dataSource にコピーされません。 | |
| dataSourceRef は、空でないボリュームが必要な場合は、ボリュームにデータを取り込むオブジェクトを指定します。これには、空ではない API グループ (コアオブジェクトではない) または PersistentVolumeClaim オブジェクトの任意のオブジェクトを指定できます。このフィールドが指定されている場合、ボリュームバインディングは、指定されたオブジェクトのタイプが、インストールされているボリュームポピュレーターまたはダイナミックプロビジョナーと一致する場合にのみ成功します。このフィールドは、dataSource フィールドの機能を置き換えるため、両方のフィールドが空でない場合は、同じ値である必要があります。下位互換性を確保するために、dataSourceRef で namespace が指定されておらず、一方が空でもう一方が空でない場合、両方のフィールド (dataSource と dataSourceRef) が自動的に同じ値に設定されます。dataSourceRef で namespace が指定されている場合、dataSource は同じ値に設定されていないため、空にする必要があります。dataSource と dataSourceRef には 3 つの重要な違いがあります。* dataSource では 2 つの特定のタイプのオブジェクトのみが使用できますが、dataSourceRef ではコアオブジェクト以外および PersistentVolumeClaim オブジェクトを使用できます。* dataSource は使用できない値を無視 (ドロップ) しますが、dataSourceRef はすべての値を保持し、使用できない値が指定された場合はエラーを生成します。* dataSource ではローカルオブジェクトのみが使用できますが、dataSourceRef では任意の namespace のオブジェクトを使用できます。(ベータ版) このフィールドを使用するには、AnyVolumeDataSource フィーチャーゲートを有効にする必要があります。(アルファ版) dataSourceRef の namespace フィールドを使用するには、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。 | |
| resources は、ボリュームに必要な最小リソースを表します。RecoverVolumeExpansionFailure 機能が有効になっている場合、ユーザーは以前の値よりも低いリソース要件を指定できますが、要求のステータスフィールドに記録された容量よりも大きい必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources | |
| selector は、バインドを考慮するボリュームに対するラベルクエリーです。 | |
|
| storageClassName は、要求に必要な StorageClass の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
|
| volumeMode は、要求に必要なボリュームのタイプを定義します。Filesystem の値は、要求仕様に含まれていない場合に暗示されます。
使用可能な列挙値: - |
|
| volumeName は、この要求をサポートする PersistentVolume へのバインディング参照です。 |
4.1.81. io.k8s.api.core.v1.PersistentVolumeClaimTemplate スキーマ
- 説明
- PersistentVolumeClaimTemplate は、EphemeralVolumeSource の一部として PersistentVolumeClaim オブジェクトを生成するために使用されます。
- 型
-
object
- 必須
-
spec
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| PVC の作成時に PVC にコピーされるラベルとアノテーションが含まれる場合があります。他のフィールドは許可されておらず、検証中に拒否されます。 | |
| PersistentVolumeClaim の仕様。コンテンツ全体が、このテンプレートから作成された PVC に変更されずにコピーされます。PersistentVolumeClaim と同じフィールドがここでも有効です。 |
4.1.82. io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource スキーマ
- 説明
- PersistentVolumeClaimVolumeSource は、同じ namespace 内のユーザーの PVC を参照します。このボリュームは、バインドされた PV を検出し、Pod 用にそのボリュームをマウントします。PersistentVolumeClaimVolumeSource は、基本的に、他の誰か (システム) が所有する別のタイプのボリュームのラッパーです。
- 型
-
object
- 必須
-
claimName
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| claimName は、このボリュームを使用する Pod と同じ namespace にある PersistentVolumeClaim の名前です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
|
| readOnly は、VolumeMounts の ReadOnly 設定が強制的に指定されます。デフォルト: false |
4.1.83. io.k8s.api.core.v1.PersistentVolumeList スキーマ
- 説明
- PersistentVolumeList は PersistentVolume 項目のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は永続ボリュームのリストです。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes | |
|
| 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#types-kinds を参照してください。 |
4.1.84. io.k8s.api.core.v1.PersistentVolumeSpec スキーマ
- 説明
- PersistentVolumeSpec は永続ボリュームの仕様です。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| accessModes には、ボリュームのマウント方法がすべて含まれています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
| awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | |
| azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。 | |
| azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。 | |
| capacity は、永続ボリュームのリソースおよび容量の説明です。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity | |
| cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。 | |
| Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md | |
| claimRef は、PersistentVolume と PersistentVolumeClaim の間の双方向バインディングの一部です。バインド時に nil 以外になると予想されます。claim.VolumeName は、PV と PVC 間の信頼できるバインドです。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding | |
| CSI は、外部 CSI ドライバー (ベータ機能) によって処理されるストレージを表します。 | |
| fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。 | |
| flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。 | |
| flocker は、kubelet のホストマシンに接続され、使用するために Pod に公開される Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります | |
| gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。管理者によってプロビジョニングされる。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | |
| glusterfs は、ホストに接続され、Pod に公開される Glusterfs ボリュームを表します。管理者によってプロビジョニングされる。詳細: https://examples.k8s.io/volumes/glusterfs/README.md | |
| hostPath は、ホスト上のディレクトリーを表します。開発者またはテスターによってプロビジョニングされる。これは単一ノードの開発およびテストにのみ役立ちます。オンホストストレージはサポートされておらず、マルチノードクラスターでは機能しません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | |
| iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。管理者によってプロビジョニングされる。 | |
| local は、ノードアフィニティーを備えた直接接続ストレージを表します | |
|
| mountOptions はマウントオプションのリストです (例: ["ro", "soft"])。検証されていません - 無効な場合、マウントは失敗します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
| nfs は、ホスト上の NFS マウントを表します。管理者によってプロビジョニングされる。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs | |
| nodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。このフィールドは、このボリュームを使用する Pod のスケジューリングに影響します。 | |
|
| persistentVolumeReclaimPolicy は、永続ボリュームの要求が解除されたときに永続ボリュームに何が起こるかを定義します。有効なオプションは Retain (手動で作成された PersistentVolumes のデフォルト)、Delete (動的にプロビジョニングされる PersistentVolumes のデフォルト)、および Recycle (非推奨) です。Recycle は、この PersistentVolume の基礎となるボリュームプラグインでサポートされる必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
使用可能な列挙値: - |
| photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。 | |
| portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。 | |
| quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します | |
| rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md | |
| scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。 | |
|
| storageClassName は、この永続ボリュームが属する StorageClass の名前です。空の値は、このボリュームが StorageClass に属していないことを意味します。 |
| storageOS は、kubelet のホストマシンに割り当てられ、Pod の詳細情報にマウントされる StorageOS ボリュームを表します。詳細: https://examples.k8s.io/volumes/storageos/README.md | |
|
| volumeMode は、ボリュームをフォーマットされたファイルシステムで使用するか、または raw ブロック状態のままにするかを定義します。Filesystem の値は、spec に含まれていない場合に暗示されます。
使用可能な列挙値: - |
| vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。 |
4.1.85. io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource スキーマ
- 説明
- Photon Controller 永続ディスクリソースを表します。
- 型
-
object
- 必須
-
pdID
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| pdID は、Photon Controller の永続ディスクを識別する ID です。 |
4.1.86. io.k8s.api.core.v1.PodAffinity スキーマ
- 説明
- Pod アフィニティーは、Pod 間アフィニティースケジューリングルールのグループです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| スケジューラーは、このフィールドで指定されたアフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アフィニティー式など) を満たすノードごとに、このフィールドの要素を反復処理して合計を計算します。ノードに対応する podAffinityTerm に一致する Pod がある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 | |
| このフィールドで指定されたアフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定されたアフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
4.1.87. io.k8s.api.core.v1.PodAffinityTerm スキーマ
- 説明
- この Pod を同じ場所に配置する (アフィニティー) または同じ場所に配置しない (アンチアフィニティー) 必要がある Pod のセット (つまり、指定された namespace に対して labelSelector に一致するもの) を定義します。この場合の同じ場所とは、キー <topologyKey> のラベルの値が、一連の Pod の Pod が実行されているノードの値と一致するノードで実行されていることを意味します。
- 型
-
object
- 必須
-
topologyKey
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| リソースのセット (この場合は Pod) に対するラベルクエリー。 | |
| 用語が適用される namespace のセットに対するラベルクエリー。この用語は、このフィールドで選択された namespace と、namespace フィールドにリストされている namespace の和集合に適用されます。null セレクターと null または空の namespace リストは "この Pod の namespace" を意味します。空のセレクター ({}) は、すべての namespace に一致します。 | |
|
| namespaces は、用語が適用される namespace 名の静的リストを指定します。この用語は、このフィールドにリストされている namespace と、namespaceSelector によって選択された namespace の和集合に適用されます。null または空の namespace リストおよび nullnamespaceSelector は、"この Pod の namespace" を意味します |
|
| この Pod は、指定された namespace の labelSelector と一致する Pod と同じ場所 (affinity) または異なる場所 (anti-affinity) に配置します。同じ場所とは、topologyKey キーが含まれるラベルの値が一致し、選択した Pod のいずれかが実行されているノード上で実行されていることを意味します。空の topologyKey は許可されていません。 |
4.1.88. io.k8s.api.core.v1.PodAntiAffinity スキーマ
- 説明
- Pod アンチアフィニティーは、Pod 間アンチアフィニティースケジューリングルールのグループです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| スケジューラーは、このフィールドで指定された非アフィニティー式を満たすノードに Pod をスケジュールすることを好みますが、1 つ以上の式に違反するノードを選択する場合があります。最も優先されるノードは、重みの合計が最大のノードです。つまり、すべてのスケジューリング要件 (リソース要求、requiredDuringScheduling アンチアフィニティー式など) を満たすノードごとに、の要素を反復処理して合計を計算します。このフィールドと、対応する podAffinityTerm に一致する Pod がノードにある場合は、合計に "重み" を追加します。合計が最も高いノードが最も優先されます。 | |
| このフィールドで指定された非アフィニティー要件がスケジュール時に満たされない場合、Pod はノードにスケジュールされません。このフィールドで指定された非アフィニティー要件が Pod 実行中のある時点で満たされない場合 (Pod ラベルの更新など)、システムは最終的に Pod をノードから削除しようとする場合としない場合があります。複数の要素がある場合、各 podAffinityTerm に対応するノードのリストが交差します。つまり、すべての用語が満たされる必要があります。 |
4.1.89. io.k8s.api.core.v1.PodDNSConfig スキーマ
- 説明
- PodDNSConfig は、DNSPolicy から生成されたパラメーターに加えて、Pod の DNS パラメーターを定義します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| DNS ネームサーバーの IP アドレスのリスト。これは、DNSPolicy から生成されたベースネームサーバーに追加されます。重複したネームサーバーは削除されます。 |
| DNS リゾルバーオプションのリスト。これは、DNSPolicy から生成された基本オプションとマージされます。重複したエントリーは削除されます。オプションで指定された解決オプションは、ベース DNS ポリシーに表示されるものをオーバーライドします。 | |
|
| ホスト名ルックアップ用の DNS 検索ドメインのリスト。これは、DNSPolicy から生成された基本検索パスに追加されます。重複する検索パスは削除されます。 |
4.1.90. io.k8s.api.core.v1.PodDNSConfigOption スキーマ
- 説明
- PodDNSConfigOption は、Pod の DNS リゾルバーオプションを定義します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 必須。 |
|
|
4.1.91. io.k8s.api.core.v1.PodList スキーマ
- 説明
- PodList は Pod のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| Pod のリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.92. io.k8s.api.core.v1.PodOS スキーマ
- 説明
- PodOS は、Pod の OS パラメーターを定義します。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、オペレーティングシステムの名前です。現在サポートされている値は linux および windows です。今後、追加の値が定義される可能性があり、https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration のいずれかになります。クライアントは、追加の値を処理し、このフィールドで認識されない値を os: null として処理する必要があります。 |
4.1.93. io.k8s.api.core.v1.PodReadinessGate スキーマ
- 説明
- PodReadinessGate には、Pod 条件への参照が含まれています
- 型
-
object
- 必須
-
conditionType
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ConditionType は、タイプが一致する Pod の条件リスト内の条件を参照します。 |
4.1.94. io.k8s.api.core.v1.PodResourceClaim スキーマ
- 説明
- PodResourceClaim は、ClaimSource を介して 1 つの ResourceClaim のみを参照します。Pod 内の ResourceClaim を一意に識別する名前を追加します。ResourceClaim へのアクセスが必要なコンテナーは、この名前で参照します。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は Pod 内でこのリソース要求を一意に識別します。これは DNS_LABEL である必要があります。 |
| source は、ResourceClaim の場所を記述します。 |
4.1.95. io.k8s.api.core.v1.PodSchedulingGate スキーマ
- 説明
- PodSchedulingGate は Pod に割り当てられ、そのスケジューリングを保護します。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| スケジューリングゲートの名前。各スケジューリングゲートには一意の name フィールドが必要です。 |
4.1.96. io.k8s.api.core.v1.PodSecurityContext スキーマ
- 説明
- PodSecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。一部のフィールドは container.securityContext にも存在します。container.securityContext のフィールド値は、PodSecurityContext のフィールド値よりも優先されます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| Pod の全コンテナーに適用される特別な補助グループです。一部のボリュームタイプでは、Kubelet がそのボリュームの所有権を Pod が所有するように変更できます。 1.所有する GID は FSGroup2 になります。setgid ビットが設定されます (ボリュームに作成された新しいファイルは FSGroup によって所有されます)3。許可ビットは rw-rw---- と OR 演算されます 設定されていないと、Kubelet はボリュームの所有権および権限を変更しません。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| fsGroupChangePolicy は、Pod 内部で公開する前にボリュームの所有権とアクセス権を変更する動作を定義します。このフィールドは、fsGroup ベースの所有権 (および権限) をサポートするボリュームタイプにのみ適用されます。secret、configmaps、emptydir などのエフェメラルボリュームタイプには影響しません。有効な値は "OnRootMismatch" と "Always" です。指定しない場合は "Always" を使用します。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
使用可能な列挙値: - |
|
| コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
|
| コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
| すべてのコンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。SecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値がそのコンテナーに優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 | |
| この Pod のコンテナーで使用する seccomp オプション。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 | |
|
| コンテナーのプライマリー GID、fsGroup (指定されている場合)、およびコンテナープロセスの uid に対してコンテナーイメージで定義されているグループメンバーシップに加えて、各コンテナーで実行される最初のプロセスに適用されるグループのリスト。指定しない場合、追加のグループはコンテナーに追加されません。コンテナープロセスの uid のコンテナーイメージで定義されたグループメンバーシップは、このリストに含まれていない場合でも引き続き有効であることに注意してください。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
| Sysctl は、Pod に使用される名前空間化された sysctl のリストを保持します。(コンテナーランタイムによる) サポートされていない sysctl を持つ Pod は起動に失敗する可能性があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 | |
| すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、コンテナーの SecurityContext 内のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。 |
4.1.97. io.k8s.api.core.v1.PodSpec スキーマ
- 説明
- PodSpec は Pod の説明です。
- 型
-
object
- 必須
-
containers
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| システムがアクティブに失敗のマークを付けて関連するコンテナーを強制終了する前に、StartTime を基準にして Pod がノード上でアクティブになる可能性がある秒単位のオプションの期間。その値は正の整数でなければなりません。 |
| 指定されている場合、Pod のスケジューリング制約 | |
|
| AutomountServiceAccountToken は、サービスアカウントトークンを自動的にマウントする必要があるかどうかを示します。 |
| Pod に属するコンテナーのリスト。現在、コンテナーを追加または削除することはできません。Pod には少なくとも 1 つのコンテナーが必要です。これを更新することはできません。 | |
| Pod の DNS パラメーターを指定します。ここで指定されたパラメーターは、DNSPolicy に基づいて生成された DNS 設定にマージされます。 | |
|
| Pod の DNS ポリシーを設定します。デフォルトは "ClusterFirst" です。有効な値は、'ClusterFirstWithHostNet'、'ClusterFirst'、'Default'、または 'None' です。DNSConfig で指定された DNS パラメーターは、DNSPolicy で選択されたポリシーとマージされます。hostNetwork とともに DNS オプションを設定するには、DNS ポリシーを 'ClusterFirstWithHostNet' に明示的に指定する必要があります。
使用可能な列挙値: - |
|
| EnableServiceLinks は、Docker リンクの構文と一致して、サービスに関する情報を Pod の環境変数に挿入する必要があるかどうかを示します。オプション: デフォルトは true です。 |
| この Pod で実行されるエフェメラルコンテナーのリスト。エフェメラルコンテナーを既存の Pod で実行して、デバッグなどのユーザーが開始するアクションを実行できます。このリストは、Pod の作成時に指定することはできません。また、Pod の仕様を更新して変更することもできません。エフェメラルコンテナーを既存の Pod に追加するには、Pod のエフェメラルコンテナーサブリソースを使用します。 | |
| HostAliases は、指定された場合に Pod の hosts ファイルに注入されるホストおよび IP のオプションのリストです。これは、hostNetwork 以外の Pod にのみ有効です。 | |
|
| ホストの ipc 名前空間を使用します。オプション: デフォルトは false です。 |
|
| この Pod に要求されたホストネットワーク。ホストのネットワーク名前空間を使用します。このオプションを設定する場合は、使用するポートを指定する必要があります。デフォルトは false です。 |
|
| ホストの pid 名前空間を使用します。オプション: デフォルトは false です。 |
|
| ホストのユーザー namespace を使用します。任意: デフォルトは true です。true に設定するか存在しない場合、Pod はホストユーザーの namespace で実行されます。これは、CAP_SYS_MODULE を使用したカーネルモジュールのロードなど、ホストユーザー namespace でのみ利用できる機能が Pod に必要な場合に役立ちます。false に設定すると、Pod 用に新しい userns が作成されます。false に設定すると、コンテナーブレークアウトの脆弱性を軽減するのに役立ち、ユーザーがホスト上で実際に root 権限を持たずにコンテナーを root として実行できるようになります。このフィールドはアルファレベルであり、UserNamespacesSupport 機能を有効にするサーバーでのみ認識されます。 |
|
| Pod のホスト名を指定します指定しない場合、Pod のホスト名はシステム定義の値に設定されます。 |
| ImagePullSecrets は、この PodSpec で使用されるイメージをプルするために使用する、同じ名前空間内のシークレットへの参照のオプションのリストです。指定されている場合、これらのシークレットは、使用するために個々のプラー実装に渡されます。詳細: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod | |
| Pod に属する初期化コンテナーのリスト。コンテナーが開始される前に、初期化コンテナーが順番に実行されます。init コンテナーに障害が発生した場合、Pod は障害が発生したと見なされ、restartPolicy に従って処理されます。init コンテナーまたは通常のコンテナーの名前は、すべてのコンテナー間で一意である必要があります。Init コンテナーには、ライフサイクルアクション、準備プローブ、ライブネスプローブ、またはスタートアッププローブがない場合があります。init コンテナーの resourceRequirements は、各リソースタイプの最大の要求/制限を見つけ、その値の最大値または通常のコンテナーの合計を使用することにより、スケジューリング中に考慮されます。同様の方法で、init コンテナーに制限が適用されます。現在、初期化コンテナーを追加または削除することはできません。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ | |
|
| NodeName は、この Pod を特定のノードにスケジュールするためのリクエストです。空でない場合、スケジューラーは、リソース要件に適合していると想定して、この Pod をそのノードにスケジュールするだけです。 |
|
| NodeSelector は、Pod がノードに収まるようにするために true である必要があるセレクターです。そのノードでスケジュールされる Pod のノードのラベルと一致する必要があるセレクター。詳細: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
| Pod 内のコンテナーの OS を指定します。これが設定されている場合、一部の Pod およびコンテナーフィールドは制限されます。 OS フィールドが linux に設定されている場合は、-securityContext.windowsOptions のフィールドの設定を解除する必要があります。 OS フィールドが windows に設定されている場合、- spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup のフィールドを設定する必要があります。 | |
| オーバーヘッドは、特定の RuntimeClass の Pod の実行に関連するリソースオーバーヘッドを表します。このフィールドは、RuntimeClass アドミッションコントローラーによってアドミッション時に自動入力されます。RuntimeClass アドミッションコントローラーが有効になっている場合は、Pod 作成要求でオーバーヘッドを設定しないでください。RuntimeClass アドミッションコントローラーは、オーバーヘッドがすでに設定されている Pod 作成要求を拒否します。RuntimeClass が PodSpec で設定および選択されている場合、オーバーヘッドは対応する RuntimeClass で定義されている値に設定されます。それ以外の場合は、未設定のままでゼロとして扱われます。詳細は、https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md を参照してください。 | |
|
| PreemptionPolicy は、優先度の低い Pod をプリエンプトするためのポリシーです。Never、PreemptLowerPriority の 1 つ。設定されていない場合、デフォルトは PreemptLowerPriority です。
使用可能な列挙値: - |
|
| 優先度の値。さまざまなシステムコンポーネントがこのフィールドを使用して、Pod の優先度を検索します。Priority Admission Controller が有効になっている場合、ユーザーはこのフィールドを設定できません。アドミッションコントローラーは、PriorityClassName からこのフィールドに入力します。値が高いと優先順位が高くなります。 |
|
| 指定されている場合、Pod の優先度を示します。"system-node-critical" と "system-cluster-critical" は、最も高い優先度を示す 2 つの特別なキーワードであり、前者が最も高い優先度です。その他の名前は、その名前で PriorityClass オブジェクトを作成して定義する必要があります。指定しない場合、Pod の優先度はデフォルトになり、デフォルトがない場合はゼロになります。 |
| 指定した場合、すべての準備ゲートが Pod の準備状況に対して評価されます。すべてのコンテナーの準備が整い、準備ゲートで指定されたすべての条件のステータスが "True" になると、Pod の準備が整います。詳細: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates | |
| ResourceClaims は、Pod の起動を許可する前にどの ResourceClaim を割り当てて予約する必要があるかを定義します。リソースは、名前ベースでリソースを使用するコンテナーに提供されます。 これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。 このフィールドは不変です。 | |
|
| Pod 内のすべてのコンテナーのポリシーを再起動します。Always、OnFailure、Never のいずれか。コンテキストによっては、これらの値のサブセットのみが使用できます。デフォルトは Always です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
使用可能な列挙値: - |
|
| RuntimeClassName は、node.k8s.io グループ内の RuntimeClass オブジェクトを参照します。このオブジェクトは、この Pod を実行するために使用する必要があります。指定されたクラスに一致する RuntimeClass リソースがない場合、Pod は実行されません。設定されていないか空の場合は、"レガシー" の RuntimeClass が使用されます。これは、デフォルトのランタイムハンドラーを使用する空の定義を持つ暗黙のクラスです。詳細は、https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class を参照してください。 |
|
| 指定した場合、Pod は指定したスケジューラーによってディスパッチされます。指定しない場合、Pod はデフォルトのスケジューラーによってディスパッチされます。 |
| SchedulingGates は、指定されている場合に Pod のスケジューリングをブロックする不透明な値のリストです。schedulingGates が空でない場合、Pod は SchedulingGated 状態のままになり、スケジューラーは Pod のスケジュールを試行しません。 SchedulingGates を設定できるのは Pod の作成時にのみで、それ以降は削除されます。 これは、PodSchedulingReadiness フィーチャーゲートによって有効になるベータ機能です。 | |
| SecurityContext は、Pod レベルのセキュリティー属性と一般的なコンテナー設定を保持します。オプション: デフォルトは空です。各フィールドのデフォルト値は、タイプの説明を参照してください。 | |
|
| DeprecatedServiceAccount は、ServiceAccountName の減価償却されたエイリアスです。非推奨: 代わりに serviceAccountName を使用してください。 |
|
| ServiceAccountName は、この Pod の実行に使用する ServiceAccount の名前です。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
|
| true の場合、Pod のホスト名は、リーフ名 (デフォルト) ではなく、Pod の FQDN として設定されます。Linux コンテナーでは、これはカーネルのホスト名フィールド (struct utsname のノード名フィールド) に FQDN を設定することを意味します。Windows コンテナーでは、これはレジストリーキー HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters のホスト名のレジストリー値を FQDN に設定することを意味します。Pod に FQDN がない場合、これは効果がありません。デフォルトは false です。 |
|
| Pod 内のすべてのコンテナー間で単一のプロセス名前空間を共有します。これが設定されると、コンテナーは同じ Pod 内の他のコンテナーからのプロセスを表示および通知できるようになり、各コンテナーの最初のプロセスには PID1 が割り当てられません。HostPID と ShareProcessNamespace の両方を設定することはできません。オプション: デフォルトは false です。 |
|
| 指定した場合、完全修飾 Pod のホスト名は "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>" になります。指定しない場合、Pod にはドメイン名がまったくありません。 |
|
| Pod が正常に終了する必要がある秒単位のオプションの期間。削除リクエストで減少する可能性があります。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。この値が nil の場合、代わりにデフォルトの猶予期間が使用されます。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。デフォルトは 30 秒です。 |
| 指定されている場合、Pod の許容範囲。 | |
| TopologySpreadConstraints は、Pod のグループがトポロジードメイン全体にどのように分散するべきかを説明します。スケジューラーは、制約に従う方法で Pod をスケジュールします。すべての topologySpreadConstraints は AND 演算されます。 | |
| Pod に属するコンテナーによってマウントできるボリュームのリスト。詳細: https://kubernetes.io/docs/concepts/storage/volumes |
4.1.98. io.k8s.api.core.v1.PodTemplateList スキーマ
- 説明
- PodTemplateList は PodTemplates のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| Pod テンプレートのリスト | |
|
| 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#types-kinds を参照してください。 |
4.1.99. io.k8s.api.core.v1.PodTemplateSpec スキーマ
- 説明
- PodTemplateSpec は、テンプレートから作成する際に Pod が要求するデータを記述します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
| Pod に期待される動作の仕様。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
4.1.100. io.k8s.api.core.v1.PortworxVolumeSource スキーマ
- 説明
- PortworxVolumeSource は、Portworx ボリュームリソースを表します。
- 型
-
object
- 必須
-
volumeID
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
|
| volumeID は、Portworx ボリュームを一意に識別します |
4.1.101. io.k8s.api.core.v1.PreferredSchedulingTerm スキーマ
- 説明
- 空の優先スケジューリング用語は、暗黙の重み 0 を持つすべてのオブジェクトに一致します (つまり、操作なしです)。null の優先スケジューリング用語は、オブジェクトに一致しません (つまり、no-op でもあります)。
- 型
-
object
- 必須
-
weight
-
preference
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| 対応する重みに関連付けられたノードセレクター用語。 | |
|
| 対応する nodeSelectorTerm の一致に関連する重み (1〜100 の範囲)。 |
4.1.102. io.k8s.api.core.v1.Probe スキーマ
- 説明
- プローブは、コンテナーが稼働しているか、トラフィックを受け取る準備ができているかどうかを判断するために、コンテナーに対して実行されるヘルスチェックを記述します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| Exec は実行するアクションを指定します。 | |
|
| 正常に実行された後に失敗とみなされるプローブの連続失敗回数の最小値。デフォルトは 3 です。最小値は 1 です。 |
| GRPC は、GRPC ポートに関連するアクションを指定します。 | |
| HTTPGet は、実行する http リクエストを指定します。 | |
|
| コンテナーが起動してから liveness プローブが開始されるまでの秒数。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
|
| プローブを実行する頻度 (秒単位)。デフォルトは 10 秒です。最小値は 1 です。 |
|
| 失敗後に、プローブが正常とみなされるための最小の連続成功回数。デフォルトは 1 です。活気と起動のために 1 でなければなりません。最小値は 1 です。 |
| TCPSocket は、TCP ポートを含むアクションを指定します。 | |
|
| プローブの障害時に Pod が正常に終了する必要がある秒単位のオプションの期間。猶予期間とは、Pod で実行されているプロセスに終了シグナルが送信されてから、kill シグナルでプロセスを強制的に終了するまでの期間 (秒単位) です。この値は、プロセスの予想されるクリーンアップ時間よりも長く設定します。この値が nil の場合、Pod の terminationGracePeriodSeconds が使用されます。それ以外の場合、この値は Pod 仕様によって提供される値をオーバーライドします。値は負の値ではない整数にする必要があります。値ゼロは、キル信号を介してすぐに停止することを示します (シャットダウンする機会はありません)。これはベータフィールドであり、ProbeTerminationGracePeriod 機能ゲートを有効にする必要があります。最小値は 1 です。未設定の場合は spec.terminationGracePeriodSeconds が使用されます。 |
|
| プローブがタイムアウトするまでの秒数。デフォルトは 1 秒です。最小値は 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
4.1.103. io.k8s.api.core.v1.ProjectedVolumeSource スキーマ
- 説明
- Projected ボリュームソースを表します
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| defaultMode は、作成されたファイルにデフォルトでアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
| source は、ボリュームプロジェクションのリストです。 |
4.1.104. io.k8s.api.core.v1.QuobyteVolumeSource スキーマ
- 説明
- Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
- 型
-
object
- 必須
-
registry
-
volume
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| アクセスできるボリュームをマップするグループ。デフォルトは no group です。 |
|
| ここでの readOnly は、Quobyte ボリュームを読み取り専用のアクセス権限で強制的にマウントします。デフォルトは false です。 |
|
| registry は、host:port ペアの文字列として指定された単一または複数の Quobyte Registry サービスを表し (複数のエントリーはコンマで区切る)、ボリュームの中央レジストリーとして機能します。 |
|
| 動的にプロビジョニングされた Quobyte ボリュームで使用されるバックエンドで指定の Quobyte ボリュームを所有するテナント。値はプラグインにより設定されます。 |
|
| アクセスできるボリュームをマップするグループ。デフォルトは serivceaccount user です。 |
|
| volume は、すでに作成されているクオバイトボリュームを名前で参照する文字列です。 |
4.1.105. io.k8s.api.core.v1.RBDPersistentVolumeSource スキーマ
- 説明
- Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
monitors
-
image
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
| image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
| secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | |
|
| user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
4.1.106. io.k8s.api.core.v1.RBDVolumeSource スキーマ
- 説明
- Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
- 必須
-
monitors
-
image
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするボリュームのファイルシステムタイプです。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd |
|
| image は rados イメージ名です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| keyring は、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| monitors は Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| pool は rados プール名です。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
|
| この readOnly は、VolumeMounts で ReadOnly 設定が強制的に指定されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
| secretRef は、RBDUser の認証シークレットの名前です。提供されている場合、キーリングをオーバーライドします。デフォルトは nil です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it | |
|
| user は rados ユーザー名です。これにより、プール内にイメージを作成できます。デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it |
4.1.107. io.k8s.api.core.v1.ReplicationControllerList スキーマ
- 説明
- ReplicationControllerList はレプリケーションコントローラーのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| レプリケーションコントローラーのリスト。詳細は、https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.108. io.k8s.api.core.v1.ResourceClaim スキーマ
- 説明
- ResourceClaim は、PodSpec.ResourceClaims 内の 1 つのエントリーを参照します。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、このフィールドが使用される Pod の pod.spec.resourceClaims に含まれる、1 つのエントリーの名前と一致する必要があります。これにより、そのリソースがコンテナー内で利用可能になります。 |
4.1.109. io.k8s.api.core.v1.ResourceFieldSelector スキーマ
- 説明
- ResourceFieldSelector は、コンテナーリソース (CPU、メモリー) とその出力形式を表します。
- 型
-
object
- 必須
-
resource
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| コンテナー名: ボリュームには必須、env 変数にはオプション |
| 公開されたリソースの出力形式を指定します。デフォルトは "1" です。 | |
|
| 必須: 選択するリソース |
4.1.110. io.k8s.api.core.v1.ResourceQuotaList スキーマ
- 説明
- ResourceQuotaList は ResourceQuota 項目のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| Items は、ResourceQuota オブジェクトのリストです。詳細: https://kubernetes.io/docs/concepts/policy/resource-quotas/ | |
|
| 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#types-kinds を参照してください。 |
4.1.111. io.k8s.api.core.v1.ResourceRequirements スキーマ
- 説明
- ResourceRequirements は、コンピュートリソースの要件を説明します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| Claims には、spec.resourceClaims で定義され、このコンテナーによって使用されるリソースの名前がリストされます。 これはアルファフィールドであり、DynamicResourceAllocation フィーチャーゲートを有効にする必要があります。 このフィールドは不変です。これはコンテナーにのみ設定できます。 | |
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 | |
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
4.1.112. io.k8s.api.core.v1.ScaleIOPersistentVolumeSource スキーマ
- 説明
- ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します
- 型
-
object
- 必須
-
gateway
-
system
-
secretRef
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。 |
|
| gateway は、ScaleIO API ゲートウェイのホストアドレスです。 |
|
| protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
| secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。 | |
|
| sslEnabled は、ゲートウェイとの SSL 通信を有効/無効にするフラグです。デフォルトは false です |
|
| storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。 |
|
| storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。 |
|
| system は、ScaleIO で設定されたストレージシステムの名前です。 |
|
| volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。 |
4.1.113. io.k8s.api.core.v1.ScaleIOVolumeSource スキーマ
- 説明
- ScaleIOVolumeSource は、永続的な ScaleIO ボリュームを表します
- 型
-
object
- 必須
-
gateway
-
system
-
secretRef
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。デフォルトは "xfs" です。 |
|
| gateway は、ScaleIO API ゲートウェイのホストアドレスです。 |
|
| protectionDomain は、設定されたストレージの ScaleIO 保護ドメインの名前です。 |
|
| readOnly。デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
| secretRef は、ScaleIO ユーザーおよびその他の機密情報の秘密を参照します。これが指定されていない場合、ログイン操作は失敗します。 | |
|
| sslEnabled Flag は、ゲートウェイとの SSL 通信を有効/無効にします。デフォルトは false です |
|
| storageMode は、ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。 |
|
| storagePool は、保護ドメインに関連付けられた ScaleIO ストレージプールです。 |
|
| system は、ScaleIO で設定されたストレージシステムの名前です。 |
|
| volumeName は、このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前です。 |
4.1.114. io.k8s.api.core.v1.SeccompProfile スキーマ
- 説明
- SeccompProfile は、Pod/コンテナーの seccomp プロファイル設定を定義します。設定できるプロファイルソースは 1 つだけです。
- 型
-
object
- 必須
-
type
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| localhostProfile は、ノード上のファイルで定義されたプロファイルを使用する必要があることを示します。プロファイルが機能するには、ノードで事前に設定されている必要があります。kubelet の設定済みの seccomp プロファイルの場所を基準にして、降順のパスである必要があります。タイプが "Localhost" の場合にのみ設定する必要があります。 |
|
| type は、適用される seccomp プロファイルの種類を示します。有効なオプションは以下のとおりです。 Localhost - ノード上のファイルで定義されたプロファイルを使用する必要があります。RuntimeDefault- コンテナーのランタイムデフォルトプロファイルを使用する必要があります。制限なし - プロファイルを適用しないでください。
使用可能な列挙値: - |
4.1.115. io.k8s.api.core.v1.SecretEnvSource スキーマ
- 説明
SecretEnvSource は、環境変数に入力するシークレットを選択します。
ターゲットシークレットのデータフィールドの内容は、キーと値のペアを環境変数として表します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| シークレットを定義する必要があるかどうかを指定します |
4.1.116. io.k8s.api.core.v1.SecretKeySelector スキーマ
- 説明
- SecretKeySelector は、シークレットのキーを選択します。
- 型
-
object
- 必須
-
key
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 選択するシークレットのキー。有効な秘密鍵でなければなりません。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| シークレットかそのキーを定義する必要があるかどうかを指定します。 |
4.1.117. io.k8s.api.core.v1.SecretList スキーマ
- 説明
- SecretList はシークレットのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はシークレットオブジェクトのリストです。詳細: https://kubernetes.io/docs/concepts/configuration/secret | |
|
| 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#types-kinds を参照してください。 |
4.1.118. io.k8s.api.core.v1.SecretProjection スキーマ
- 説明
シークレットを、デプロイメントされたボリュームに適合させます。
ターゲットシークレットの Data フィールドの内容は、ファイル名として Data フィールドのキーを使用して、ファイルとしてデプロイメントされたボリュームに表示されます。これは、デフォルトモードのないシークレットボリュームソースと同じであることに注意してください。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 | |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| オプションフィールドは、シークレットかそのキーを定義する必要があるかどうかを指定します。 |
4.1.119. io.k8s.api.core.v1.SecretReference スキーマ
- 説明
- SecretReference は、Secret Reference を表します。namespace でシークレットを取得するのに十分な情報があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、namespace 内で一意であり、シークレットのリソースを参照します。 |
|
| namespace は、シークレットの名前が一意でなければならないスペースを定義します。 |
4.1.120. io.k8s.api.core.v1.SecretVolumeSource スキーマ
- 説明
シークレットをボリュームに適合させます。
ターゲットシークレットの Data フィールドの内容は、ファイル名として Data フィールドのキーを使用してファイルとしてボリュームに表示されます。シークレットボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| defaultMode は任意: デフォルトで、作成されたファイルのアクセス許可を設定するために使用されるモードビットです。0000 から 0777 の 8 進数値、または 0 から 511 までの 10 進数の値である必要があります。YAML は 8 進数および 10 進数値の両方を受け入れます。JSON にはモードビットに 10 進数の値が必要です。デフォルトは 0644 に設定されます。パス内のディレクトリーはこの設定の影響を受けません。これは fsGroup などのファイルモードに影響する他のオプションと競合する可能性があり、その結果は他のモードビットセットである可能性があります。 |
| items が指定されていない場合、参照されるシークレットの Data フィールドのそれぞれのキーと値のペアはボリュームにデプロイメントされ、名前がキーであり、内容が値になります。指定されている場合、リスト表示されるキーは指定されたパスにデプロイメントされ、リストされていないキーはありません。シークレットに存在しないキーが指定された場合、ボリュームのセットアップはオプションとしてマークされない限りエラーになります。パスは相対する必要があり、'..' パスが含まれないか、または '..' で始まる場合があります。 | |
|
| optional フィールド。シークレットかそのキーを定義する必要があるかどうかを指定します。 |
|
| secretName は、使用する Pod の namespace 内のシークレットの名前です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret |
4.1.121. io.k8s.api.core.v1.SecurityContext スキーマ
- 説明
- SecurityContext は、コンテナーに適用されるセキュリティー設定を保持します。一部のフィールドは、SecurityContext と PodSecurityContext の両方に存在します。両方が設定されている場合は、SecurityContext の値が優先されます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| AllowPrivilegeEscalation は、プロセスがその親プロセスよりも多くの特権を取得できるかどうかを制御します。このブール値は、no_new_privs フラグがコンテナープロセスに設定されるかどうかを直接制御します。コンテナーが 1) 特権で実行されており、CAP_SYS_ADMIN が割り当てられている場合、2) AllowPrivilegeEscalation は常に true です。spec.os.name が windows の場合は、このフィールドは設定できないことに注意してください。 |
| コンテナーの実行時に追加/削除する機能。デフォルトは、コンテナーランタイムによって付与されるデフォルトの機能セットです。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 | |
|
| コンテナーを特権モードで実行します。特権コンテナー内のプロセスは、基本的にホスト上の root と同等です。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| procMount は、コンテナーに使用する proc マウントのタイプを示します。デフォルトは DefaultProcMount で、読み取り専用パスとマスクされたパスにコンテナーランタイムのデフォルトを使用します。これには、ProcMountType 機能フラグを有効にする必要があります。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。
使用可能な列挙値: - |
|
| このコンテナーに読み取り専用のルートファイルシステムがあるかどうか。デフォルトは false です。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナープロセスのエントリーポイントを実行するための GID。設定されていない場合は、実行時のデフォルトを使用します。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
|
| コンテナーが root 以外のユーザーとして実行される必要があることを示します。true の場合、Kubelet は実行時にイメージを検証して、イメージが UID 0(ルート) として実行されないことを確認し、実行される場合はコンテナーの開始に失敗します。未設定または false の場合、そのような検証は実行されません。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
|
| コンテナープロセスのエントリーポイントを実行するための UID。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 |
| コンテナーに適用される SELinux コンテキスト。指定しない場合、コンテナーランタイムはコンテナーごとにランダムな SELinux コンテキストを割り当てます。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 | |
| このコンテナーで使用する seccomp オプション。Pod とコンテナーの両方のレベルで seccomp オプションが提供されている場合、コンテナーオプションは Pod オプションを上書きします。spec.os.name が Windows の場合、このフィールドは設定できないことに注意してください。 | |
| すべてのコンテナーに適用される Windows 固有の設定。指定しない場合、PodSecurityContext のオプションが使用されます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。spec.os.name が linux の場合は、このフィールドを設定できないことに注意してください。 |
4.1.122. io.k8s.api.core.v1.SELinuxOptions スキーマ
- 説明
- SELinuxOptions は、コンテナーに適用されるラベルです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| Level は、コンテナーに適用される SELinux レベルのラベルです。 |
|
| Role は、コンテナーに適用される SELinux ロールラベルです。 |
|
| Type は、コンテナーに適用される SELinux タイプのラベルです。 |
|
| User は、コンテナーに適用される SELinux ユーザーラベルです。 |
4.1.123. io.k8s.api.core.v1.ServiceAccountList スキーマ
- 説明
- ServiceAccountList は ServiceAccount オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| ServiceAccount のリストです。詳細: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ | |
|
| 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#types-kinds を参照してください。 |
4.1.124. io.k8s.api.core.v1.ServiceAccountTokenProjection スキーマ
- 説明
- ServiceAccountTokenProjection は、デプロイメントされるサービスアカウントトークンボリュームを表します。このプロジェクションを使用して、API (Kubernetes API サーバーなど) に対して使用するサービスアカウントトークンを Pod ランタイムファイルシステムに挿入できます。
- 型
-
object
- 必須
-
path
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| audience は、トークンの対象オーディエンスです。トークンの受信者は、トークンのオーディエンスで指定された識別子で自分自身を識別する必要があります。そうでない場合は、トークンを拒否する必要があります。対象はデフォルトで API サーバーの識別子に設定されます。 |
|
| expirationSeconds は、サービスアカウントトークンの要求された有効期間です。トークンの有効期限が近づくと、kubelet ボリュームプラグインはサービスアカウントトークンをプロアクティブにローテーションします。トークンが存続時間の 80% より古い場合、またはトークンが 24 時間より古い場合、kubelet はトークンのローテーションを開始します。デフォルトは 1 時間で、少なくとも 10 分である必要があります。 |
|
| path は、トークンのデプロイメント先となるファイルのマウントポイントに対する相対パスです。 |
4.1.125. io.k8s.api.core.v1.ServiceList スキーマ
- 説明
- ServiceList はサービスのリストを保持します。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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#types-kinds を参照してください。 |
4.1.126. io.k8s.api.core.v1.StorageOSPersistentVolumeSource スキーマ
- 説明
- StorageOS 永続ボリュームリソースを表します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
| secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。 | |
|
| volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は namespace 内でのみ一意です。 |
|
| volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない名前空間が作成されます。 |
4.1.127. io.k8s.api.core.v1.StorageOSVolumeSource スキーマ
- 説明
- StorageOS 永続ボリュームリソースを表します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| readOnly のデフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。 |
| secretRef は、StorageOS API クレデンシャルを取得するために使用するシークレットを指定します。指定しない場合、デフォルト値が試行されます。 | |
|
| volumeName は、人間が判読えきる形式の StorageOS ボリュームの名前です。ボリューム名は namespace 内でのみ一意です。 |
|
| volumeNamespace は、StorageOS 内のボリュームのスコープを指定します。namespace が指定されていない場合は、Pod の namespace が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で namespace を使用していない場合は、"デフォルト" に設定します。StorageOS 内に事前に存在しない名前空間が作成されます。 |
4.1.128. io.k8s.api.core.v1.Sysctl スキーマ
- 説明
- Sysctl は、設定するカーネルパラメーターを定義します
- 型
-
object
- 必須
-
name
-
value
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 設定するプロパティーの名前 |
|
| 設定するプロパティーの値 |
4.1.129. io.k8s.api.core.v1.TCPSocketAction スキーマ
- 説明
- TCPSocketAction は、ソケットを開くことに基づくアクションを記述します
- 型
-
object
- 必須
-
port
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| オプション: 接続するホスト名。デフォルトは Pod IP です。 |
| コンテナーでアクセスするポートの番号または名前。番号は 1〜65535 の範囲である必要があります。名前は IANA_SVC_NAME である必要があります。 |
4.1.130. io.k8s.api.core.v1.Toleration スキーマ
- 説明
- この toleration が割り当てられる Pod は、マッチング Operator <operator> を使用してトリプル <key,value,effect> と一致する taint を許容します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| effect は、照合するテイントの効果を示します。空の場合は、すべてのテイント効果に一致します。指定されている場合、許可される値は NoSchedule、PreferNoSchedule、および NoExecute です。
使用可能な列挙値: - |
|
| key は toleration が適用されるテイントキーです。空の場合は、すべてのテイントキーに一致します。キーが空の場合、Operator は Exists である必要があります。この組み合わせは、すべての値とすべてのキーに一致することを意味します。 |
|
| Operator はキーと値の関係を表します。有効な Operator は Exists および Equal です。デフォルトは Equal です。Exists は、値のワイルドカードと同等であるため、Pod は特定のカテゴリーのすべてのテイントに耐えることができます。
使用可能な列挙値: - |
|
| tolerationSeconds は、toleration (effect は NoExecute でなければならず、NoExecute 以外の場合このフィールドは無視されます) が taint を許容する期間を表します。デフォルトでは設定されていません。つまり、テイントを永久に許容します (エビクトしないでください)。ゼロ値と負の値は、システムによって 0 (すぐにエビクト) として扱われます。 |
|
| value は、toleration が一致するテイントの値です。Operator が Exists の場合、値は空である必要があります。それ以外の場合は、通常の文字列のみになります。 |
4.1.131. io.k8s.api.core.v1.TopologySelectorLabelRequirement スキーマ
- 説明
- トポロジーセレクターの要件は、指定のラベルに一致するセレクターです。これはアルファ機能であり、今後変更される可能性があります。
- 型
-
object
- 必須
-
key
-
values
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| セレクターが適用されるラベルキー。 |
|
| 文字列値の配列。1 つの値が選択するラベルと一致する必要があります。値の各エントリーは ORed です。 |
4.1.132. io.k8s.api.core.v1.TopologySelectorTerm スキーマ
- 説明
- トポロジーセレクター用語は、ラベルクエリーの結果を表します。null または空のトポロジーセレクター用語は、オブジェクトには一致しません。これらの要件は AND で結合されます。NodeSelectorTerm として機能のサブセットを提供します。これはアルファ機能であり、今後変更される可能性があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| ラベル別のトポロジーセレクター要件のリスト。 |
4.1.133. io.k8s.api.core.v1.TopologySpreadConstraint スキーマ
- 説明
- topologySpreadConstraint は、指定されたトポロジー間で一致する Pod を分散する方法を指定します。
- 型
-
object
- 必須
-
maxSkew
-
topologyKey
-
whenUnsatisfiable
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| LabelSelector は、一致する Pod を見つけるために使用されます。このラベルセレクターに一致する Pod は、対応するトポロジードメイン内の Pod の数を決定するためにカウントされます。 | |
|
| MatchLabelKeys は、分散を計算する Pod を選択するための Pod ラベルキーのセットです。このようなキーは受信 Pod のラベルから値を検索するために使用され、このキーと値のラベルは labelSelector と AND 演算されて、受信 Pod の分散が計算される既存の Pod のグループを選択します。同じキーが MatchLabelKeys と LabelSelector の両方に存在することはできません。LabelSelector が設定されていないと、MatchLabelKeys は設定できません。受信 Pod ラベルに存在しないキーは無視されます。null または空のリストは、labelSelector とのみ一致することを意味します。 これはベータフィールドであり、MatchLabelKeysInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。 |
|
|
MaxSkew は、Pod が不均一に分布している可能性の程度を表します。 |
|
| MinDomains は、対象となるドメインの最小数を示します。トポロジーキーが一致する適格なドメインの数が minDomains より少ない場合、Pod Topology Spread は "グローバル最小値" を 0 として扱い、スキューの計算が実行されます。また、トポロジーキーが一致する適格なドメインの数が minDomains の数以上の場合、この値はスケジュールに影響しません。その結果、対象となるドメインの数が minDomains より少ない場合、スケジューラーはそれらのドメインに対して maxSkew を超える Pod をスケジュールしません。値が nil の場合、制約は MinDomains が 1 と等しいかのように動作します。有効な値は 0 より大きい整数です。値が nil でない場合、WhenUnsatisfiable は DoNotSchedule でなければなりません。 たとえば、3 ゾーンクラスターの場合、MaxSkew は 2 に設定され、MinDomains は 5 に設定され、同じ labelSelector を持つ Pod は 2/2/2 に分散されます ( | zone1 | zone2 | zone3 | | P P | P | P | P P | P P | P P | P |)。ドメインの数は 5 (MinDomains 未満) であるため、"global minimum" は 0 として扱われます。このような場合、同じ labelSelector を持つ新しい Pod をスケジュールすることはできません。新しい Pod が 3 つのゾーンのいずれかにスケジュールされている場合、スキューは 3(3 - 0) と計算され、MaxSkew に違反するためです。 これはベータフィールドであり、MinDomainsInPodTopologySpread フィーチャーゲートを有効にする必要があります (デフォルトで有効)。 |
|
| nodeAffinityPolicy は、Pod トポロジーの分散スキューを計算するときに Pod の nodeAffinity/nodeSelector をどのように扱うかを示します。オプションは - Honor: nodeAffinity/nodeSelector に一致するノードのみが計算に含まれます。- Ignore: nodeAffinity/nodeSelector は無視されます。すべてのノードが計算に含まれます。 この値が nil の場合、この動作は Honor ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによってデフォルトで有効になるベータレベルの機能です。
使用可能な列挙値: - |
|
| NodeTaintsPolicy は、Pod トポロジースプレッドスキューを計算するときにノードのテイントを処理する方法を示します。オプション: - Honor: テイントのないノードと、受信 Pod が許容範囲でテイントがあるノードが含まれます。- Ignore: ノードのテイントは無視されます。すべてのノードが含まれます。 この値が nil の場合、この動作は Ignore ポリシーと同じです。これは、NodeInclusionPolicyInPodTopologySpread 機能フラグによってデフォルトで有効になるベータレベルの機能です。
使用可能な列挙値: - |
|
| TopologyKey は、ノードラベルのキーです。このキーと同じ値のラベルを持つノードは、同じトポロジーにあると見なされます。各 <key, value> を "バケット" と見なし、バランスの取れた数の Pod を各バケットに配置しようとします。ドメインをトポロジーの特定のインスタンスとして定義します。また、ノードが nodeAffinityPolicy および nodeTaintsPolicy の要件を満たすドメインとして、適格なドメインを定義します。たとえば、TopologyKey が "kubernetes.io/hostname" の場合、各ノードはそのトポロジーのドメインです。また、TopologyKey が "topology.kubernetes.io/zone" の場合は、各ゾーンがそのトポロジーのドメインになります。必須フィールドです。 |
|
| WhenUnsatisfiable は、スプレッドの制約を満たさない場合に Pod を処理する方法を示します。-DoNotSchedule (デフォルト) は、スケジューラーにスケジュールしないように指示します。--ScheduleAnyway は、任意の場所で Pod をスケジュールするようにスケジューラーに指示しますが、スキューを減らすのに役立つトポロジーに高い優先順位を与えます。受信 Pod に対する制約は、対象となる Pod へのノード割り当て候補すべてがトポロジーの一部の "MaxSkew" に違反する場合に、"Unsatisfiable" とみなされます。たとえば、3 ゾーンクラスターでは、MaxSkew は 1 に設定され、labelSelector が同じ Pod は 3/1/1 ( | zone1 | zone2 | zone3 | | P P P | P | P |) に分散されます。WhenUnsatisfiable が DoNotSchedule に設定されている場合、zone2(zone3) の ActualSkew(2-1) が MaxSkew(1) を満たすため、受信 Pod は zone2(zone3) にのみスケジュールして 3/2/1(3/1/2) になります。つまり、クラスターは依然として不均衡である可能性がありますが、スケジューラーによってクラスターが さらに 不均衡になることはありません。必須フィールドです。
使用可能な列挙値: - |
4.1.134. io.k8s.api.core.v1.TypedLocalObjectReference スキーマ
- 説明
- TypedLocalObjectReference には、同じ namespace 内で typed 参照オブジェクトを見つけるのに十分な情報が含まれます。
- 型
-
object
- 必須
-
kind
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
4.1.135. io.k8s.api.core.v1.TypedObjectReference スキーマ
- 説明
- 型
-
object
- 必須
-
kind
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| APIGroup は参照されているリソースのグループです。APIGroup が指定されていない場合は、指定の Kind をコア API グループに設定する必要があります。他のサードパーティータイプには、APIGroup が必要です。 |
|
| kind は参照されているリソースのタイプです。 |
|
| name は、参照されているリソースの名前です。 |
|
| Namespace は、参照されるリソースの namespace です。namespace が指定されている場合は、その namespace の所有者が参照を受け入れることができるように、参照された namespace に gateway.networking.k8s.io/ReferenceGrant オブジェクトが必要であることに注意してください。詳細は、ReferenceGrant ドキュメントを参照してください。(アルファ版) このフィールドでは、CrossNamespaceVolumeDataSource フィーチャーゲートを有効にする必要があります。 |
4.1.136. io.k8s.api.core.v1.Volume スキーマ
- 説明
- ボリュームは、Pod 内の任意のコンテナーからアクセスできる Pod 内の名前付きボリュームを表します。
- 型
-
object
- 必須
-
name
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| awsElasticBlockStore は、kubelet のホストマシンに割り当てられ、Pod に公開される AWS Disk リソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore | |
| azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。 | |
| azureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。 | |
| cephFS は、Pod の有効期間を共有するホストでの Ceph FS マウントを表します。 | |
| Cinder は、kubelets ホストマシンに接続およびマウントされた Cinder ボリュームを表します。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md | |
| configMap は、このボリュームに入力する必要がある configMap を表します | |
| csi (Container Storage Interface) は、特定の外部 CSI ドライバー (ベータ機能) によって処理される一時的なストレージを表します。 | |
| downwardAPI は、このボリュームに入力する必要がある Pod に関する Downward API を表します | |
| emptyDir は、Pod の存続期間を共有する一時ディレクトリーを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#emptydir | |
| ephemeral は、クラスターストレージドライバーによって処理されるボリュームを表します。ボリュームのライフサイクルは、ボリュームを定義する Pod に関連付けられています。ボリュームは、Pod が起動する前に作成され、Pod が削除されると削除されます。 これは、次の場合に使用します。a)Pod の実行中にのみボリュームが必要、b) スナップショットからの復元や容量追跡などの通常のボリュームの機能が必要、c) ストレージドライバーがストレージクラスを通じて指定される、d) ストレージドライバー PersistentVolumeClaim を介した動的ボリュームプロビジョニングをサポートします (このボリュームタイプと PersistentVolumeClaim の間の接続の詳細は、EphemeralVolumeSource を参照してください)。 個々の Pod のライフサイクルより長く持続するボリュームには、PersistentVolumeClaim またはベンダー固有の API の 1 つを使用します。 CSI ドライバーをそのように使用する場合は、軽量のローカルエフェメラルボリュームに CSI を使用します。詳細は、ドライバーのドキュメントを参照してください。 Pod は、両方のタイプのエフェメラルボリュームとパーシステントボリュームを同時に使用できます。 | |
| fc は、kubelet のホストマシンに接続されてから Pod に公開されるファイバーチャネルリソースを表します。 | |
| flexVolume は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用ボリュームリソースを表します。 | |
| flocker は、kubelet のホストマシンに接続されている Flocker ボリュームを表します。これは、実行中の Flocker 制御サービスによって異なります | |
| gcePersistentDisk は、kubelet のホストマシンに接続されてから Pod に公開される GCE ディスクリソースを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk | |
| gitRepo は、特定のリビジョンの git リポジトリーを表します。非推奨:GitRepo は非推奨です。git レポジトリを使用してコンテナーをプロビジョニングするには、Git を使用してレポジトリのクローンを作成する InitContainer に EmptyDir をマウントしてから、Pod のコンテナーに EmptyDir をマウントします。 | |
| glusterfs は、Pod の存続期間を共有するホスト上の Glusterfs マウントを表します。詳細: https://examples.k8s.io/volumes/glusterfs/README.md | |
| hostPath は、コンテナーに直接公開されているホストマシン上の既存のファイルまたはディレクトリーを表します。これは通常、ホストマシンの表示を許可されているシステムエージェントまたはその他の特権的なものに使用されます。ほとんどのコンテナーはこれを必要としません。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath | |
| iscsi は、kubelet のホストマシンに接続されてから Pod に公開される ISCSI ディスクリソースを表します。詳細: https://examples.k8s.io/volumes/iscsi/README.md | |
|
| ボリュームの名前。DNS_LABEL であり、Pod 内で一意である必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
| NFS は、Pod の有効期間を共有するホスト上の NFS マウントを表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs | |
| persistentVolumeClaimVolumeSource は、同じ namespace 内の PersistentVolumeClaim への参照を表します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims | |
| photonPersistentDisk は、kubelets ホストマシンに接続されマウントされた PhotonController 永続ディスクを表します。 | |
| portworxVolume は、kubelet ホストマシンに接続およびマウントされた portworx ボリュームを表します。 | |
| オールインワンリソースシークレット、configmaps、および Downward API のアイテム | |
| quobyte は、Pod の有効期限を共有するホストでの Quobyte マウントを表します | |
| rbd は、Pod の有効期間を共有するホストの Rados ブロックデバイスマウントを表します。詳細: https://examples.k8s.io/volumes/rbd/README.md | |
| scaleIO は、Kubernetes ノードに接続およびマウントされた ScaleIO 永続ボリュームを表します。 | |
| secret は、このボリュームに入力する必要がある Secret を表します。詳細: https://kubernetes.io/docs/concepts/storage/volumes#secret | |
| storageOS は、Kubernetes ノードに接続およびマウントされた StorageOS ボリュームを表します。 | |
| vsphereVolume は、kubelet ホストマシンに接続およびマウントされた vSphere ボリュームを表します。 |
4.1.137. io.k8s.api.core.v1.VolumeDevice スキーマ
- 説明
- volumeDevice は、コンテナー内の raw ブロックデバイスのマッピングを記述します。
- 型
-
object
- 必須
-
name
-
devicePath
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| devicePath は、デバイスがマップされるコンテナー内のパスです。 |
|
| name は、Pod 内の persistentVolumeClaim の名前と一致する必要があります |
4.1.138. io.k8s.api.core.v1.VolumeMount スキーマ
- 説明
- VolumeMount は、コンテナー内でのボリュームのマウントを説明します。
- 型
-
object
- 必須
-
name
-
mountPath
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ボリュームをマウントする必要があるコンテナー内のパス。':' を含めることはできません。 |
|
| mountPropagation は、マウントがホストからコンテナーに、またはその逆にどのように伝播されるかを決定します。設定されていない場合、MountPropagationNone が使用されます。このフィールドは 1.10 のベータ版です。
使用可能な列挙値: - |
|
| ボリュームの名前に一致する必要があります。 |
|
| true の場合は読み取り専用、それ以外の場合は読み取り/書き込み (false または指定なし) でマウントされます。デフォルトは false です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内のパス。デフォルトは "" (ボリュームのルート) です。 |
|
| コンテナーのボリュームをマウントする必要があるボリューム内の拡張パス。SubPath と同様に動作しますが、環境変数参照 $(VAR_NAME) は、コンテナーの環境を使用してデプロイメントされます。デフォルトは "" (ボリュームのルート) です。SubPathExpr と SubPath は相互に排他的です。 |
4.1.139. io.k8s.api.core.v1.VolumeNodeAffinity スキーマ
- 説明
- VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| required は、満たす必要のあるハードノード制約を指定します。 |
4.1.140. io.k8s.api.core.v1.VolumeProjection スキーマ
- 説明
- サポートされている他のボリュームタイプと一緒にデプロイメントされる可能性のあるプロジェクション
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| プロジェクトへの configMap データの ConfigMap 情報 | |
| downwardAPI データのプロジェクトへの downwardAPI 情報 | |
| 投影するシークレットデータに関する情報 | |
| serviceAccountToken は、投影する serviceAccountToken データに関する情報です。 |
4.1.141. io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource スキーマ
- 説明
- vSphere ボリュームリソースを表します。
- 型
-
object
- 必須
-
volumePath
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| fsType は、マウントするファイルシステムタイプです。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例: "ext4"、"xfs"、"ntfs"。指定されていない場合、暗黙的に "ext4" であると推測されます。 |
|
| storagePolicyID は、StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID です。 |
|
| storagePolicyName は、ストレージポリシーベースの管理 (SPBM) プロファイル名です。 |
|
| volumePath は、vSphere ボリューム vmdk を識別するパスです。 |
4.1.142. io.k8s.api.core.v1.WeightedPodAffinityTerm スキーマ
- 説明
- 一致したすべての WeightedPodAffinityTerm フィールドの重みがノードごとに追加され、最も優先されるノードが検索されます。
- 型
-
object
- 必須
-
weight
-
podAffinityTerm
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| 必須。対応する重みに関連付けられた Pod アフィニティー用語。 | |
|
| 対応する podAffinityTerm の一致に関連する重み (1〜100 の範囲)。 |
4.1.143. io.k8s.api.core.v1.WindowsSecurityContextOptions スキーマ
- 説明
- WindowsSecurityContextOptions には、Windows 固有のオプションおよび認証情報が含まれています。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| GMSACredentialSpec は、GMSA アドミッション Webhook (https://github.com/kubernetes-sigs/windows-gmsa) が GMSACredentialSpecName フィールドで指定された GMSA クレデンシャル仕様のコンテンツをインライン化する場所です。 |
|
| GMSACredentialSpecName は、使用する GMSA 認証情報仕様の名前です。 |
|
| hostProcess は、コンテナーを 'Host Process' コンテナーとして実行する必要があるかどうかを決定します。このフィールドはアルファレベルであり、WindowsHostProcessContainers 機能フラグを有効にするコンポーネントによってのみ尊重されます。機能フラグなしでこのフィールドを設定すると、Pod の検証時にエラーが発生します。Pod のすべてのコンテナーは、同じ有効な HostProcess 値を持っている必要があります (HostProcess コンテナーと非 HostProcess コンテナーを混在させることはできません)。さらに、HostProcess が true の場合、HostNetwork も true に設定する必要があります。 |
|
| コンテナープロセスのエントリーポイントを実行するための Windows の UserName。指定されていない場合、デフォルトでイメージメタデータで指定されたユーザーになります。PodSecurityContext で設定することもできます。SecurityContext と PodSecurityContext の両方で設定されている場合、SecurityContext で指定された値が優先されます。 |
4.1.144. io.k8s.api.discovery.v1.EndpointSliceList スキーマ
- 説明
- EndpointSliceList はエンドポイントスライスのリストを表します。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はエンドポイントスライスのリストです。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準のリストメタデータ。 |
4.1.145. io.k8s.api.events.v1.EventList スキーマ
- 説明
- EventList は Event オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はスキーマオブジェクトのリストです。 | |
|
| 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 を参照してください。 |
4.1.146. io.k8s.api.flowcontrol.v1beta3.FlowSchemaList スキーマ
- 説明
- FlowSchemaList は FlowSchema オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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 を参照してください。 |
|
|
4.1.147. io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfigurationList スキーマ
- 説明
- PriorityLevelConfigurationList は PriorityLevelConfiguration オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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 を参照してください。 |
|
|
4.1.148. io.k8s.api.networking.v1.IngressClassList スキーマ
- 説明
- IngressClassList は IngressClasses のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は IngressClasses のリストです。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準のリストメタデータ。 |
4.1.149. io.k8s.api.networking.v1.IngressList スキーマ
- 説明
- IngressList は Ingress のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は Ingress のリストです。 | |
|
| 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 を参照してください。 |
4.1.150. io.k8s.api.networking.v1.NetworkPolicyList スキーマ
- 説明
- NetworkPolicyList は NetworkPolicy オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はスキーマオブジェクトのリストです。 | |
|
| 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 を参照してください。 |
4.1.151. io.k8s.api.node.v1.RuntimeClassList スキーマ
- 説明
- RuntimeClassList は RuntimeClass オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items はスキーマオブジェクトのリストです。 | |
|
| 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 を参照してください。 |
4.1.152. io.k8s.api.policy.v1.PodDisruptionBudgetList スキーマ
- 説明
- PodDisruptionBudgetList は PodDisruptionBudget のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は PodDisruptionBudget のリストです。 | |
|
| 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 を参照してください。 |
4.1.153. io.k8s.api.rbac.v1.ClusterRoleBindingList スキーマ
- 説明
- ClusterRoleBindingList は ClusterRoleBindings のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| アイテムは ClusterRoleBindings のリストです | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。 |
4.1.154. io.k8s.api.rbac.v1.ClusterRoleList スキーマ
- 説明
- ClusterRoleList は、ClusterRoles のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は ClusterRole のリストです。 | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。 |
4.1.155. io.k8s.api.rbac.v1.RoleBindingList スキーマ
- 説明
- RoleBindingList は RoleBindings のコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| アイテムは RoleBindings のリストです | |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。 |
4.1.156. io.k8s.api.rbac.v1.RoleList スキーマ
- 説明
- RoleList はロールのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 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 を参照してください。 |
| 標準オブジェクトのメタデータ。 |
4.1.157. io.k8s.api.scheduling.v1.PriorityClassList スキーマ
- 説明
- PriorityClassList は priority クラスのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は PriorityClasses のリストです。 | |
|
| 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 |
4.1.158. io.k8s.api.storage.v1.CSIDriverList スキーマ
- 説明
- CSIDriverList は CSIDriver オブジェクトのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は CSIDriver のリストです。 | |
|
| 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 |
4.1.159. io.k8s.api.storage.v1.CSINodeList スキーマ
- 説明
- CSINodeList は CSINode オブジェクトのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は CSINode のリストです。 | |
|
| 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 |
4.1.160. io.k8s.api.storage.v1.CSIStorageCapacityList スキーマ
- 説明
- CSIStorageCapacityList は CSIStorageCapacity オブジェクトのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は CSIStorageCapacity オブジェクトのリストです。 | |
|
| 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 |
4.1.161. io.k8s.api.storage.v1.StorageClassList スキーマ
- 説明
- StorageClassList はストレージクラスのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は StorageClass のリストです。 | |
|
| 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 |
4.1.162. io.k8s.api.storage.v1.VolumeAttachmentList スキーマ
- 説明
- VolumeAttachmentList は、VolumeAttachment オブジェクトのコレクションです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は VolumeAttachment のリストです。 | |
|
| 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 |
4.1.163. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionList スキーマ
- 説明
- CustomResourceDefinitionList は CustomResourceDefinition オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は個々の CustomResourceDefinition オブジェクトをリスト表示します。 | |
|
| 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 |
4.1.164. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation スキーマ
- 説明
- ExternalDocumentation を使用すると、拡張ドキュメントの外部リソースを参照できます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| |
|
|
4.1.165. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSON スキーマ
- 説明
- JSON は、有効な JSON 値を表します。サポート対象のタイプは、bool、int64、float64、string、[]interface{}、map[string]interface{}、nil です。
- 型
- ``
4.1.166. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps schema
- 説明
- JSONSchemaProps は Specification Draft 4 (http://json-schema.org/) に準拠した JSON スキーマです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| |
|
| |
| ||
| ||
| ||
| ||
| default は、未定義のオブジェクトフィールドのデフォルト値です。defaulting は CustomResourceDefaulting 機能ゲートのベータ機能です。defaulting では、spec.preserveUnknownFields が false である必要があります。 | |
| ||
| ||
|
| |
| ||
| ||
|
| |
|
| |
| ||
|
| format は OpenAPI v3 形式の文字列です。不明な形式は無視されます。以下のフォーマットが検証されます。 - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "FFFFFF: following the regex ^?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. |
|
| |
| ||
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
|
| |
| ||
|
| |
| ||
| ||
|
| |
|
| |
|
| |
|
| |
|
| x-kubernetes-embedded-resource は、TypeMeta および ObjectMeta を使用して、値が埋め込み型 Kubernetes runtime.Object であることを定義します。タイプは object である必要があります。埋め込まれたオブジェクトをさらに制限することができます。kind、apiVersion、およびメタデータは自動的に検証されます。x-kubernetes-preserve-unknown-fields は true にできますが、オブジェクトが完全に指定されている場合 (kind、apiVersion、metadata まで) は true である必要はありません。 |
|
| x-kubernetes-int-or-string は、この値が整数または文字列のいずれかであることを指定します。true の場合、空の型を使用でき、以下のいずれかのパターンに従い anyOf の子としての型が許可されます。 1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - … zero or more |
|
|
x-kubernetes-list-map-keys は、マップのインデックスとして使用されるキーを指定して、配列に x-kubernetes-list-type このタグは、"x-kubernetes-list-type" エクステンションが "map" に設定されているリストでのみ使用する必要があります。また、この属性に指定する値は、子構造のスカラー型フィールドである必要があります (ネストはサポートされていません)。 指定されたプロパティーは、すべてのリストアイテムに確実に存在するように、必須であるかデフォルト値を持っている必要があります。 |
|
| x-kubernetes-list-type は、トポロジーをさらに記述するためにアレイにアノテーションを付けます。この拡張機能はリストでのみ使用する必要があり、3 つの値を使用できます。
1) |
|
| x-kubernetes-map-type は、そのトポロジーをさらに記述するためにオブジェクトにアノテーションを付けます。このエクステンションは、タイプが object で、2 つの値がある可能性がある場合にのみ使用します。
1) |
|
| x-kubernetes-preserve-unknown-fields は、検証スキーマで指定されていないフィールドのプルーニングから、API サーバーのデコードステップを停止します。これはフィールドに再帰的に影響しますが、ネストされたプロパティーまたは additionalProperties がスキーマで指定されている場合、通常のプルーニング動作に戻ります。これは true または undefined のいずれかになります。false は禁止されています。 |
|
x-kubernetes-validations は、CEL 式言語で記述された検証ルールのリストを記述します。このフィールドはアルファレベルです。このフィールドを使用するには、 |
4.1.167. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrArray スキーマ
- 説明
- JSONSchemaPropsOrArray は、JSONSchemaProps または JSONSchemaProps の配列のいずれかの値を表します。主にシリアル化の目的で使用されます。
- 型
- ``
4.1.168. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrBool スキーマ
- 説明
- JSONSchemaPropsOrBool は、JSONSchemaProps またはブール値を表します。boolean プロパティーのデフォルト値は true です。
- 型
- ``
4.1.169. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrStringArray スキーマ
- 説明
- JSONSchemaPropsOrStringArray は JSONSchemaProps または文字列配列を表します。
- 型
- ``
4.1.170. io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.ValidationRule スキーマ
- 説明
- ValidationRule は、CEL 式言語で記述された検証ルールを記述します。
- 型
-
object
- 必須
-
rule
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| message は、検証が失敗したときに表示されるメッセージを表します。ルールに改行が含まれる場合、message は必須です。message には改行を含めることはできません。設定されていない場合、メッセージは "failed rule: {Rule}" になります (例: "must be a URL with the host matching spec.host")。 |
|
| MessageExpression は、このルールが失敗した場合に返される検証失敗メッセージを評価する CEL 式を宣言します。messageExpression は失敗メッセージとして使用されるため、文字列として評価される必要があります。message と messageExpression の両方がルールに存在する場合、検証が失敗した場合は messageExpression が使用されます。messageExpression の結果としてランタイムエラーが発生した場合、そのランタイムエラーがログに記録され、messageExpression フィールドが設定されていない場合と同様に検証失敗メッセージが生成されます。messageExpression が空の文字列、スペースのみの文字列、または改行を含む文字列と評価された場合、messageExpression フィールドが設定されていないかのように検証失敗メッセージも生成され、messageExpression が空の文字列 (スペース/改行の文字列のみが含まれる) が生成されたことがログに記録されます。messageExpression は、ルールと同じ変数すべてにアクセスできます。唯一の違いは戻り値の型です。(例: "x must be less than max ("string (self.max) ") ")。 |
|
|
Rule は、CEL によって評価される式を表します。詳細: https://github.com/google/cel-spec ルールのスコープは、スキーマ内の x-kubernetes-validations 拡張機能の場所に限定されます。CEL 式の
Rule のスコープが、プロパティーのあるオブジェクトに設定されている場合は、オブジェクトの中のアクセス可能なプロパティーは
x-kubernetes-preserve-unknown-fields 経由でカスタムリソースに保存された不明なデータには、CEL 式ではアクセスできません。これには、x-kubernetes-preserve-unknown-fields のオブジェクトスキーマによって保持される不明なフィールド値と、プロパティースキーマが "unknown type" のオブジェクトプロパティーが含まれます。"unknown type" は、型がなく、x-kubernetes-preserve-unknown-fields が True に設定されているスキーマ、- アイテムスキーマの型が "unknown type" の配列 - additionalProperties schema の型が "unknown type" のオブジェクトとして再帰的に定義されます。
x-kubernetes-list-type が 'set' または 'map' である配列の等価性は、要素の順序を無視します ([1, 2] == [2, 1])。x-kubernetes-list-type による配列の連結では、リストタイプのセマンティクスを使用します。- 'set': |
4.1.171. io.k8s.apimachinery.pkg.api.resource.Quantity schema
- 説明
quantity は、数値の固定ポイント表現です。String() および AsInt64() アクセサーに加えて、JSON および YAML での便利なマーシャリング/アンマーシャリングを提供します。
シリアライズの形式は以下のとおりです。
<quantity> ::= <signedNumber><suffix>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow (Note that <suffix> may be empty, from the "" case in <decimalSI>.)
(Note that <suffix> may be empty, from the "" case in <decimalSI>.)
<digit> ::= 0 | 1 | … | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei
Copy to Clipboard Copied! Toggle word wrap Toggle overflow (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
(International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)
<decimalSI> ::= m | "" | k | M | G | T | P | E
Copy to Clipboard Copied! Toggle word wrap Toggle overflow (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
(Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)
<decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber>
3 つの指数形式のいずれを使用する場合でも、数量が 2^63-1 を超える数値を表すことはできません。また、小数点以下 3 桁を超えることもできません。それを上回る数値、または正確な数値は、上限が適用されるか切り上げられます。(例: 0.1 m は 1 m に切り上げられます。)より多くのまたはより少ない量が必要な場合、将来拡張される可能性があります。
Quantity が文字列から解析されると、その接尾辞のタイプが記憶されシリアライズ時に同じタイプが使用されます。
シリアライズ前に、Quantity は "正規形式" にされます。これは、Exponent/接尾辞が以下のように上下に調整されることを意味します (対応して Mantissa も増加または減少)。
- 精度は失われません - 小数点以下の桁は出力されません - 指数 (または接尾辞) は可能な限り大きくなります。
数字が負の値でない限り、記号は省略されます。
例 :
- 1.5 は "1500m" として、1.5Gi は "1536Mi" としてシリアル化されます。
数量が浮動小数点数で内部的に表されることは決してないことに注意してください。それがこの演習で最も重要な点です。
非正規値も形成されている限り解析されますが、正規の形式で再省略されます。(したがって、常に正規形式を使用するか、違いを作らないでください。)
この形式は、実装者が固定小数点実装も使用することを期待して、何らかの特別な処理コードを記述しなければ、数値の使用が困難になるようにすることを目的としています。
- 型
-
string
4.1.172. io.k8s.apimachinery.pkg.apis.meta.v1.Condition スキーマ
- 説明
- 条件には、この API リソースの現在の状態の詳細が含まれます。
- 型
-
object
- 必須
-
type
-
status
-
lastTransitionTime
-
reason
-
message
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 | |
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。 |
4.1.173. io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions スキーマ
- 説明
- DeleteOptions は、API オブジェクトを削除する際に指定できる場合があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合は、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合は、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 非推奨。PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、"孤立した" ファイナライザーがオブジェクトのファイナライザーリストで追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
| 削除を実行する前に満たしている必要があります。不可能な場合は、409 Conflict ステータスが返されます。 | |
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定できません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシーです。 |
4.1.174. io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1 schema
- 説明
FieldsV1 は、一連のフィールドを Trie のようなデータ構造に JSON 形式で保存します。
各キーは、フィールド自体を表し、空のセットに常にマッピングする '.' か、サブフィールドまたはアイテムを表す文字列です。文字列は、'f:<name>' (<name> は構造体のフィールドの名前またはマップ内のキー)、または 'v:<value>' (<value> はリストアイテムの正確な json 形式の値)、'i:<index>' (<index> はリスト内のアイテムの位置)、'k:<keys>' (<keys> は、キーがからのフィールド値をマッピングし、キーの表現がセットの一部となっているフィールドの場合、リストアイテムのキーフィールドから一意の値へのマッピング) のいずれか 4 つの形式に従います。
正確な形式は sigs.k8s.io/structured-merge-diff で定義されています。
- 型
-
object
4.1.175. io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector schema
- 説明
- ラベルセレクターとは、一連のリソースに対するラベルクエリー機能です。matchLabels と matchExpressions の結果は AND を使用して結合されます。ラベルセレクターが空の場合は、全オブジェクトをマッチします。ラベルセレクターが null の場合は、どのオブジェクトもマッチしません。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| matchExpressions はラベルセレクターの要件のリストです。要件は AND で結合されます。 | |
|
| matchLabels は、{key,value} ペアのマップです。matchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには "key"、演算子には "In"、値配列には "value" のみが含まれます。要件は AND で結合されます。 |
4.1.176. io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement スキーマ
- 説明
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- 型
-
object
- 必須
-
key
-
operator
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| key は、セレクターの適用先のラベルキーです。 |
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
4.1.177. io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta スキーマ
- 説明
- ListMeta は、リストやさまざまなステータスオブジェクトなど、合成リソースに必要なメタデータを記述します。リソースには、{ObjectMeta、ListMeta} のいずれか 1 つしか含めることができません。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ユーザーが返されたアイテムの数に制限を設定し、サーバーがより多くのデータを利用できることを示している場合、continue を設定できます。値は不透明であり、このリストを提供したエンドポイントに別の要求を発行して、使用可能なオブジェクトの次のセットを取得するために使用できます。サーバー設定が変更された場合、または数分以上経過した場合、一貫性のあるリストを継続できない場合があります。この continue の値を使用すると返される resourceVersion フィールドは、エラーメッセージからこのトークンを受け取っていない限り、最初のレスポンスの値と同じになります。 |
|
| remainingItemCount は、このリストレスポンスに含まれていないリスト内の後続のアイテムの数です。リスト要求にラベルまたはフィールドセレクターが含まれる場合、残りのアイテム数は不明で、このフィールドは未設定のままとなり、シリアライズ時に省略されます。リストが完全である場合 (チャンク化されていない、またはこれが最後のチャンクの場合)、残りのアイテムはなくなり、このフィールドは未設定のままになり、シリアライズ時に省略されます。v1.15 よりも古いサーバーはこのフィールドを設定しません。remainingItemCount は、コレクションのサイズを 見積もる ために使用します。クライアントは、remainingItemCount が設定されている、または正確であることに依存してはなりません。 |
|
| オブジェクトがいつ変更されたかを判断するためにクライアントが使用できる、このオブジェクトのサーバーの内部バージョンを識別する文字列。値はクライアントによって不透明として扱われ、変更されずにサーバーに返される必要があります。システムによって入力されます。read-only詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 非推奨: selfLink は従来の読み取り専用フィールドであり、システムによって入力されなくなりました。 |
4.1.178. io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry schema
- 説明
- ManagedFieldsEntry は、workflow-id、FieldSet、および FieldSet が適用されるリソースのグループバージョンです。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion は、このフィールドの設定が適用されるこのリソースのバージョンを定義します。形式は、最上位の APIVersion フィールドと同様に "group/version" です。フィールドセットは自動的に変換できないため、バージョンを追跡する必要があります。 |
|
| FieldsType は、さまざまなフィールド形式およびバージョンの識別子です。現在、可能な値は "FieldsV1" の 1 つだけです。 |
| FieldsV1 は、"FieldsV1" タイプで説明されている最初の JSON バージョン形式を保持します。 | |
|
| Manager は、これらのフィールドを管理するワークフローの識別子です。 |
|
| operation は、この ManagedFieldsEntry が作成される操作のタイプです。このフィールドの有効な値は、'Apply' と 'Update' のみです。 |
|
| Subresource は、オブジェクトの更新に使用されるサブリソースの名前か、オブジェクトがメインリソースを通じて更新された場合は空の文字列です。このフィールドの値は、マネージャー間で同じ名前を共有している場合でも、マネージャーを区別するために使用されます。たとえば、ステータスの更新は、同じマネージャー名を使用する通常の更新とは異なります。APIVersion フィールドは Subresource フィールドとは関係がなく、常にメインリソースのバージョンに対応することに注意してください。 |
| Time は、ManagedFields エントリーが追加されたときのタイムスタンプです。このタイムスタンプは、フィールドが追加された場合、管理者が所有するフィールドの値を変更した場合、またはフィールドを削除した場合にも更新されます。別のマネージャーがエントリーからフィールドが削除されても、タイムスタンプは更新されません。 |
4.1.179. io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime schema
- 説明
- MicroTime は、マイクロ秒レベルの精度を持つ Time のバージョンです。
- 型
-
string
4.1.180. io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta スキーマ
- 説明
- ObjectMeta は、すべての永続化されたリソースが持つ必要のあるメタデータであり、ユーザーが作成する必要のあるすべてのオブジェクトが含まれます。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| アノテーションは、任意のメタデータを保存し、取得するために外部ツールで設定できる、リソースとともに保存される構造化されていないキー値のマップです。これらはクエリーできないため、オブジェクトを変更する場合に維持する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations |
| CreationTimestamp は、このオブジェクトが作成された時のサーバー時間を表すタイムスタンプです。別々の操作をまたいで、happens-before の順序が設定されることは保証されていません。クライアントはこの値を設定できません。これは RFC3339 形式で表されます。これは UTC です。 システムによって入力されます。read-onlyリストの場合は Null。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| このオブジェクトがシステムから削除される前に、正常に終了するのに許可された秒数。deletionTimestamp も設定されている場合にのみ設定されます。短縮のみ可能です。read-only |
| deletionTimestamp は、このリソースが削除される RFC 3339 の日時です。このフィールドは、ユーザーが適切な削除を要求したときにサーバーによって設定され、クライアントが直接設定することはできません。ファイナライザーリストが空になり、このフィールドの時間が経過すると、リソースは削除される (リソースリストからは表示されなくなり、名前で到達できなくなる) ことが想定されます。ファイナライザーリストにアイテムが含まれている限り、削除はブロックされます。deletionTimestamp が設定された後は、短縮したり、この時間の前にリソースを削除したりすることはできますが、この値を設定または設定解除することはできなくなります。たとえば、ユーザーは Pod を 30 秒で削除するように要求できます。Kubelet は、正常な終了シグナルを Pod のコンテナーに送信して反応します。その 30 秒後、Kubelet はハードターミネーションシグナル (SIGKILL) をコンテナーに送信し、クリーンアップ後、API から Pod を削除します。ネットワークパーティションが存在する場合、このオブジェクトは、管理者または自動化されたプロセスがリソースの完全終了を判断できるまで、このタイムスタンプの後も存在する可能性があります。設定されていない場合、オブジェクトの正常な削除は要求されていません。 正常な削除が要求されたときにシステムによって入力されます。read-only詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| オブジェクトをレジストリーから削除する前に、空にする必要があります。各エントリーは、リストからエントリーを削除する責任のあるコンポーネントの識別子です。オブジェクトの deletionTimestamp が nil ではない場合、このリストのエントリーのみを削除できます。ファイナライザーは任意の順序で処理および削除できます。ファイナライザーのスタックに大きなリスクが発生するため、順序は強制されません。ファイナライザーは共有フィールドであり、パーミッションを持つすべてのアクターが並べ替えることができます。ファイナライザーリストが順番に処理されると、リストの最初のファイナライザーを担当するコンポーネントが、リストの後半にあるファイナライザーによるシグナル生成を待つという状況が引き起こされ、その結果としてデッドロックが発生します。強制的な順序付けが行われない場合、ファイナライザーはリスト内で自由に並べ替えることができ、並べ替えに対する脆弱性はありません。 |
|
| generateName は、Name フィールドが指定されていない場合に限り一意の名前を生成するためにサーバーが使用するオプションの接頭辞です。このフィールドを使用する場合、クライアントに返される名前は渡された名前とは異なります。この値は、一意の接尾辞とも組み合わされます。提供された値には、名前フィールドと同じ検証ルールがあり、サーバー上で値を一意にするために必要な接尾辞の長さで切り捨てられる場合があります。 このフィールドが指定されており、生成された名前が存在する場合、サーバーは 409 を返します。 Name が指定されていない場合にのみ適用されます。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency |
|
| 目的の状態の特定の生成を表すシーケンス番号。システムによって入力されます。read-only |
|
| オブジェクトの整理と分類 (スコープと選択) に使用できる文字列キーと値のマップ。レプリケーションコントローラーおよびサービスのセレクターと一致する場合があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels |
| managedFields は workflow-id および version を、そのワークフローが管理するフィールドセットにマッピングします。これは主に内部のハウスキーピング用であり、ユーザーは通常、このフィールドを設定または理解する必要はありません。ワークフローは、ユーザーの名前、コントローラーの名前、または "ci-cd" などの特定の適用パスの名前にすることができます。フィールドセットは、常にオブジェクトを変更するときにワークフローが使用したバージョンにあります。 | |
|
| name は namespace 内で一意である必要があります。リソースの作成時に必要ですが、リソースによっては、クライアントが適切な名前の生成を自動的に要求することを許可する場合があります。name は、主にべき等性と設定定義の作成を目的としています。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
| namespace は、各名前が一意である必要があるスペースを定義します。空の namespace は "default" の namespace と同じですが、"default" は正規表現です。すべてのオブジェクトを namespace のスコープに設定する必要はありません。それらのオブジェクトでは、このフィールドの値は空になります。 DNS_LABEL である必要があります。これを更新することはできません。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces |
| このオブジェクトが依存するオブジェクトのリスト。リスト内のすべてのオブジェクトが削除されている場合、このオブジェクトはガベージコレクションされます。このオブジェクトがコントローラーによって管理されている場合、このリストのエントリーは、コントローラーフィールドが true に設定されたこのコントローラーを指します。複数の管理コントローラーが存在することはできません。 | |
|
| オブジェクトが変更されたタイミングを判別するためにクライアントが使用できる、このオブジェクトの内部バージョンを表す不透明な値です。楽観的な並行処理、変更検出、およびリソースまたはリソースのセットに対する監視操作に使用できます。クライアントはこれらの値を不透明として処理し、変更せずにサーバーに戻す必要があります。これらは、特定のリソースまたはリソースセットでのみ有効です。 システムによって入力されます。read-only値は、クライアントによって不透明として扱われる必要があります。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 非推奨: selfLink は従来の読み取り専用フィールドであり、システムによって入力されなくなりました。 |
|
| UID は、このオブジェクトの時間およびスペースで一意の値です。これは通常、リソースの作成が成功したときにサーバーによって生成され、PUT 操作で変更することはできません。 システムによって入力されます。read-only詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
4.1.181. io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference schema
- 説明
- OwnerReference には、所有するオブジェクトを識別できるようにするための十分な情報が含まれています。所有するオブジェクトは、依存オブジェクトと同じ名前空間にあるか、クラスタースコープである必要があるため、名前空間フィールドはありません。
- 型
-
object
- 必須
-
apiVersion
-
kind
-
name
-
uid
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| true の場合、および所有者が "foregroundDeletion" ファイナライザーを持っている場合、この参照が削除されるまで、所有者を Key-Value ストアから削除することはできません。ガベージコレクターがこのフィールドと対話し、フォアグラウンドを強制的に削除する方法は、https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion を参照してください。デフォルトは false です。このフィールドを設定するには、ユーザーは所有者の "削除" 権限を必要とします。そうしないと、422 (処理不能エンティティー) が返されます。 |
|
| true の場合、この参照は管理コントローラーを指します。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
4.1.182. io.k8s.apimachinery.pkg.apis.meta.v1.Patch スキーマ
- 説明
- パッチは、Kubernetes PATCH 要求本文に具体的な名前とタイプを与えるために提供されています。
- 型
-
object
4.1.183. io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions スキーマ
- 説明
- 操作 (更新、削除など) を実行する前に、前提条件が満たされている必要があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| ターゲット ResourceVersion を指定します。 |
|
| ターゲット UID を指定します。 |
4.1.184. io.k8s.apimachinery.pkg.apis.meta.v1.Status スキーマ
- 説明
- status は、他のオブジェクトを返さない呼び出しの戻り値です。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| このステータスの推奨 HTTP 戻りコード。設定されていない場合は 0。 |
| 理由に関連付けられた拡張データ。それぞれの理由により、かくちょの詳細が定義される場合があります。このフィールドはオプションであり、返されるデータは、reason タイプで定義されている以外のスキーマに準拠することは保証されていません。 | |
|
| 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#types-kinds を参照してください。 | |
|
| この操作のステータスが "Failure" である理由の、機械による判読が可能な説明。この値が空の場合、利用可能な情報はありません。Reason は HTTP ステータスコードを明確にしますが、上書きはしません。 |
|
| 操作のステータス。"Success" または "Failure" のいずれか。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
4.1.185. io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause スキーマ
- 説明
- StatusCause は、複数のエラーが発生した場合など、api.Status エラーに関する詳細情報を提供します。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| このエラーの原因となったリソースのフィールド。JSON のシリアル化により名前が付けられます。ネストされた属性にはドットおよび接尾辞表記が含まれる場合があります。配列にはゼロからインデックスが付けられます。フィールドに複数のエラーがあるため、フィールドはエラーのある配列に複数回出現する場合があります。任意。 例: "name" - 現在のリソースのフィールド "name" "items[0].name" - "items" の最初の配列エントリーのフィールド "name" |
|
| 人間が判読できるエラーの原因の説明。このフィールドはユーザーにそのまま表示される場合があります。 |
|
| エラーの原因の機械可読な説明。この値が空の場合、利用可能な情報はありません。 |
4.1.186. io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails スキーマ
- 説明
- StatusDetails は、応答に関する追加情報を提供するためにサーバーによって設定される追加プロパティーのセットです。Status オブジェクトの Reason フィールドは、どの属性を設定するかを定義します。クライアントは、各属性の定義済みのタイプに一致しないフィールドを無視する必要があり、属性は空、無効、または定義されていない可能性があると想定する必要があります。
- 型
-
object
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| Causes 配列には、StatusReason エラーに関連する詳細が含まれています。すべての StatusReason で原因の城西情報が提供されるわけではありません。 | |
|
| ステータス StatusReason に関連付けられたリソースのグループ属性。 |
|
| ステータス StatusReason に関連付けられたリソースの kind 属性。一部の操作では、要求されたリソースの種類と異なる場合があります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| ステータス StatusReason に関連付けられたリソースの name 属性 (記述できる名前が 1 つの場合)。 |
|
| 指定した場合、操作を再試行するまでの時間を秒単位で指定します。エラーによっては、クライアントが代わりのアクションを実行する必要があることを示す場合があります。このようなエラーでは、このフィールドは代替アクションを実行するまでの待ち時間を示す場合があります。 |
|
| リソースの UID。(記述できるリソースが単一の場合)。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids |
4.1.187. io.k8s.apimachinery.pkg.apis.meta.v1.Time スキーマ
- 説明
- time は、YAML と JSON への正しいマーシャリングをサポートする time.Time のラッパーです。ラッパーは、タイムパッケージが提供するファクトリーメソッドの多くに提供されています。
- 型
-
string
4.1.188. io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent スキーマ
- 説明
- event は、監視対象リソースに対する単一のイベントを表します。
- 型
-
object
- 必須
-
type
-
object
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
| object: * Type が Added または Modified の場合、オブジェクトの新しい状態。* Type が Deleted の場合: 削除直前のオブジェクトの状態。* Type が Error の場合: *Status が推奨されます。他のタイプはコンテキストに応じて意味を持つ可能性があります。 | |
|
|
4.1.189. io.k8s.apimachinery.pkg.runtime.RawExtension スキーマ
- 説明
RawExtension は、外部バージョンでエクステンションを保持するために使用されます。
これを使用するには、外部のバージョン管理された構造で type が RawExtension で、内部構造に Object を持つフィールドを作成します。また、さまざまなプラグインタイプを登録する必要もあります。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` }
type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.Object `json:"myPlugin"` }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow type PluginA struct { AOption string `json:"aOption"` }
type PluginA struct { AOption string `json:"aOption"` }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` }
type MyAPIObject struct { runtime.TypeMeta `json:",inline"` MyPlugin runtime.RawExtension `json:"myPlugin"` }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow type PluginA struct { AOption string `json:"aOption"` }
type PluginA struct { AOption string `json:"aOption"` }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow { "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, }
{ "kind":"MyAPIObject", "apiVersion":"v1", "myPlugin": { "kind":"PluginA", "aOption":"foo", }, }
その結果、以下のとおりとなります。デコードは、最初に json または yaml を使用してシリアライズされたデータを外部の MyAPIObject にアンマーシャリングします。これにより、raw JSON が保存されますが、デプロイメントされません。次のステップは、(pkg/conversion を使用して) 内部構造体にコピーします。ランタイムパッケージの DefaultScheme には、RawExtension に格納されている JSON をデプロイメントし、正しいオブジェクトタイプに変換して、Object に格納する変換関数がインストールされています。(TODO: オブジェクトのタイプが不明な場合、runtime.Unknown オブジェクトが作成され、保存されます。)
- 型
-
object
4.1.190. io.k8s.apimachinery.pkg.util.intstr.IntOrString スキーマ
- 説明
- IntOrString は int32 または文字列を保持することができるタイプです。JSON または YAML のマーシャリングおよびアンマーシャリングで使用すると、内部タイプを生成または消費します。これにより、たとえば名前または数字を許可する JSON フィールドなどを設定できます。
- 型
-
string
4.1.191. io.k8s.kube-aggregator.pkg.apis.apiregistration.v1.APIServiceList スキーマ
- 説明
- APIServiceList は APIService オブジェクトのリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| items は APIService のリストです。 | |
|
| 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 |
4.1.192. io.k8s.migration.v1alpha1.StorageVersionMigrationList スキーマ
- 説明
- StorageVersionMigrationList は StorageVersionMigration のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| storageversionmigrations のリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.193. io.k8s.storage.snapshot.v1.VolumeSnapshotClassList スキーマ
- 説明
- VolumeSnapshotClassList は VolumeSnapshotClass のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| volumesnapshotclasses のリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.194. io.k8s.storage.snapshot.v1.VolumeSnapshotContentList スキーマ
- 説明
- VolumeSnapshotContentList は VolumeSnapshotContent のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| volumesnapshotcontents のリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.195. io.k8s.storage.snapshot.v1.VolumeSnapshotList スキーマ
- 説明
- VolumeSnapshotList は VolumeSnapshot のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| volumesnapshots のリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.196. io.openshift.internal.security.v1.RangeAllocationList スキーマ
- 説明
- RangeAllocationList は RangeAllocation のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| rangeallocations のリストです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.197. io.openshift.route.v1.RouteList スキーマ
- 説明
- RouteList は Route のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| ルートのリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.198. io.openshift.security.v1.SecurityContextConstraintsList スキーマ
- 説明
- SecurityContextConstraintsList は SecurityContextConstraints のリストです。
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| securitycontextconstraints のリスト。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
4.1.199. io.topolvm.v1.LogicalVolumeList スキーマ
- 説明
- LogicalVolumeList は LogicalVolume のリストです
- 型
-
object
- 必須
-
items
-
スキーマ
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
| logicalvolumes のリストです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md を参照してください。 | |
|
| 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#types-kinds を参照してください。 |
第5章 拡張 API
5.1. API 拡張の API
5.1.1. CustomResourceDefinition [apiextensions.k8s.io/v1]
- 説明
- CustomResourceDefinition は、API サーバーで公開する必要があるリソースを表します。その名前は <.spec.name>.<.spec.group> の形式でなければなりません。
- 型
-
object
5.2. CustomResourceDefinition [apiextensions.k8s.io/v1]
- 説明
- CustomResourceDefinition は、API サーバーで公開する必要があるリソースを表します。その名前は <.spec.name>.<.spec.group> の形式でなければなりません。
- 型
-
object
- 必須
-
spec
-
5.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 | |
|
| CustomResourceDefinitionSpec は、ユーザーがリソースをどのように表示するかを表します。 |
|
| CustomResourceDefinitionStatus は CustomResourceDefinition の状態を示します。 |
5.2.1.1. .spec
- 説明
- CustomResourceDefinitionSpec は、ユーザーがリソースをどのように表示するかを表します。
- 型
-
object
- 必須
-
group
-
names
-
scope
-
versions
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| CustomResourceConversion は、CR のさまざまなバージョンを変換する方法を説明します。 |
|
|
group は、定義されたカスタムリソースの API グループです。カスタムリソースは |
|
| CustomResourceDefinitionNames は、この CustomResourceDefinition を提供する名前を示します |
|
|
preserveUnknownFields は、OpenAPI スキーマで指定されていないオブジェクトフィールドを、ストレージに永続化するときに保持する必要があることを示します。apiVersion、kind、metadata、およびメタデータ内の既知のフィールドは常に保持されます。このフィールドは、 |
|
|
スコープは、定義されたカスタムリソースがクラスタースコープか名前空間スコープかを示します。許可される値は、 |
|
| version は、定義されたカスタムリソースのすべての API バージョンのリストです。バージョン名は、提供されたバージョンが API ディスカバリーにリストされる順序を計算するために使用されます。バージョン文字列が "kube-like" の場合、辞書式順序で並べられた "kube-like" ではないバージョン文字列の上に並べ替えられます。"Kube のような" バージョンは "v" で始まり、その後に数字 (メジャーバージョン) が続き、オプションで文字列 "alpha" または "beta" と別の数字 (マイナーバージョン) が続きます。これらは、最初に GA > ベータ > アルファ (GA はベータやアルファなどの接尾辞のないバージョン) でソートされ、次にメジャーバージョン、次にマイナーバージョンでソートされます。バージョンのソート済みリストの例: v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。 |
|
| CustomResourceDefinitionVersion は、CRD のバージョンを表します。 |
5.2.1.2. .spec.conversion
- 説明
- CustomResourceConversion は、CR のさまざまなバージョンを変換する方法を説明します。
- 型
-
object
- 必須
-
strategy
-
プロパティー | タイプ | 説明 |
---|---|---|
|
|
ストラテジーは、カスタムリソースがバージョン間でどのように変換されるかを指定します。使用可能な値は |
|
| WebhookConversion は、変換 Webhook を呼び出す方法を説明します |
5.2.1.3. .spec.conversion.webhook
- 説明
- WebhookConversion は、変換 Webhook を呼び出す方法を説明します
- 型
-
object
- 必須
-
conversionReviewVersions
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| WebhookClientConfig には、Webhook との TLS 接続を確立するための情報が含まれています。 |
|
|
conversionReviewVersions は、Webhook が期待する優先される |
5.2.1.4. .spec.conversion.webhook.clientConfig
- 説明
- WebhookClientConfig には、Webhook との TLS 接続を確立するための情報が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| caBundle は、PEM でエンコードされた CA バンドルであり、Webhook のサーバー証明書を検証するために使用されます。指定しない場合、apiserver のシステム信頼ルートが使用されます。 |
|
| ServiceReference は、Service.legacy.k8s.io への参照を保持します |
|
|
url は、Webhook の場所を標準の URL 形式 (
この Webhook を呼び出す必要がある可能性のある apiserver を実行するすべてのホストでこの Webhook を実行するように細心の注意を払わない限り、 スキームは "https" である必要があります。URL は "https://" で始まる必要があります。 パスはオプションであり、存在する場合は、URL で許可される任意の文字列にすることができます。パスを使用して、クラスター識別子などの任意の文字列を Webhook に渡すことができます。 ユーザーまたは基本認証 ("user:password@" など) を使用することは許可されていません。フラグメント ("#…") とクエリーパラメーター ("?…") も許可されていません。 |
5.2.1.5. .spec.conversion.webhook.clientConfig.service
- 説明
- ServiceReference は、Service.legacy.k8s.io への参照を保持します
- 型
-
object
- 必須
-
namespace
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name はサービスの名前です。必須 |
|
| namespace は、サービスの名前空間です。必須 |
|
| path は、Webhook が接続されるオプションの URL パスです。 |
|
|
port は、Webhook が接続されるオプションのサービスポートです。 |
5.2.1.6. .spec.names
- 説明
- CustomResourceDefinitionNames は、この CustomResourceDefinition を提供する名前を示します
- 型
-
object
- 必須
-
複数
-
kind
-
プロパティー | タイプ | 説明 |
---|---|---|
|
|
カテゴリーは、このカスタムリソースが属するグループ化されたリソースのリストです (例: 'すべて')。これは API 検出ドキュメントで公開され、クライアントが |
|
|
kind は、リソースのシリアル化された種類です。通常は CamelCase で単数です。カスタムリソースインスタンスは、この値を API 呼び出しの |
|
| listKind は、このリソースのリストのシリアル化された種類です。デフォルトは "`kind`List" です。 |
|
|
複数形は、提供するリソースの複数形の名前です。カスタムリソースは |
|
|
shortNames はリソースの短縮名であり、API 検出ドキュメントで公開され、クライアントが |
|
|
singular は、リソースの単数名です。すべて小文字である必要があります。デフォルトは小文字 |
5.2.1.7. .spec.versions
- 説明
- version は、定義されたカスタムリソースのすべての API バージョンのリストです。バージョン名は、提供されたバージョンが API ディスカバリーにリストされる順序を計算するために使用されます。バージョン文字列が "kube-like" の場合、辞書式順序で並べられた "kube-like" ではないバージョン文字列の上に並べ替えられます。"Kube のような" バージョンは "v" で始まり、その後に数字 (メジャーバージョン) が続き、オプションで文字列 "alpha" または "beta" と別の数字 (マイナーバージョン) が続きます。これらは、最初に GA > ベータ > アルファ (GA はベータやアルファなどの接尾辞のないバージョン) でソートされ、次にメジャーバージョン、次にマイナーバージョンでソートされます。バージョンのソート済みリストの例: v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。
- 型
-
array
5.2.1.8. .spec.versions[]
- 説明
- CustomResourceDefinitionVersion は、CRD のバージョンを表します。
- 型
-
object
- 必須
-
name
-
served
-
storage
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| additionalPrinterColumns は、テーブル出力で返される追加の列を指定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables を参照してください。列が指定されていない場合、カスタムリソースの経過時間を表示する単一の列が使用されます。 |
|
| CustomResourceColumnDefinition は、サーバー側の印刷用の列を指定します。 |
|
| deprecated は、このバージョンのカスタムリソース API が非推奨であることを示します。true に設定すると、このバージョンへの API リクエストは、サーバー応答で警告ヘッダーを受け取ります。デフォルトは false です。 |
|
|
deprecationWarning は、API クライアントに返されるデフォルトの警告を上書きします。 |
|
|
name はバージョン名です。たとえば、"v1"、"v2beta1" などです。カスタムリソースは、このバージョンで |
|
| CustomResourceValidation は、CustomResources の検証メソッドのリストです。 |
|
| 提供は、このバージョンが REST API を介して提供されることを有効/無効にするフラグです。 |
|
| storage は、カスタムリソースをストレージに永続化するときにこのバージョンを使用する必要があることを示します。storage=true のバージョンが 1 つだけ存在する必要があります。 |
|
| CustomResourceSubresources は、CustomResources のステータスとスケールサブリソースを定義します。 |
5.2.1.9. .spec.versions[].additionalPrinterColumns
- 説明
- additionalPrinterColumns は、テーブル出力で返される追加の列を指定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables を参照してください。列が指定されていない場合、カスタムリソースの経過時間を表示する単一の列が使用されます。
- 型
-
array
5.2.1.10. .spec.versions[].additionalPrinterColumns[]
- 説明
- CustomResourceColumnDefinition は、サーバー側の印刷用の列を指定します。
- 型
-
object
- 必須
-
name
-
type
-
jsonPath
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| description は、この列の人間が読める形式の説明です。 |
|
| format は、この列のオプションの OpenAPI タイプ定義です。'name' 形式は、クライアントが列がリソース名であることを識別するのを支援するために、1 次 ID 列に適用されます。詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types を参照してください。 |
|
| jsonPath は、この列の値を生成するために各カスタムリソースに対して評価される単純な JSON パス (つまり、配列表記を使用) です。 |
|
| name は、人間が読める形式の列の名前です。 |
|
| priority は、他の列と比較したこの列の相対的な重要度を定義する整数です。数値が小さいほど優先度が高いと見なされます。限られたスペースのシナリオで省略される可能性のある列には、0 より大きい優先順位を与える必要があります。 |
|
| type は、この列の OpenAPI 型定義です。詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types を参照してください。 |
5.2.1.11. .spec.versions[].schema
- 説明
- CustomResourceValidation は、CustomResources の検証メソッドのリストです。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| openAPIV3Schema は、検証とプルーニングに使用する OpenAPIv3 スキーマです。 |
5.2.1.12. .spec.versions[].subresources
- 説明
- CustomResourceSubresources は、CustomResources のステータスとスケールサブリソースを定義します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| CustomResourceSubresourceScale は、CustomResources のスケールサブリソースを提供する方法を定義します。 |
|
|
CustomResourceSubresourceStatus は、CustomResources のステータスサブリソースを提供する方法を定義します。ステータスは、CustomResource 内の |
5.2.1.13. .spec.versions[].subresources.scale
- 説明
- CustomResourceSubresourceScale は、CustomResources のスケールサブリソースを提供する方法を定義します。
- 型
-
object
- 必須
-
specReplicasPath
-
statusReplicasPath
-
プロパティー | タイプ | 説明 |
---|---|---|
|
|
labelSelectorPath は、 |
|
|
specReplicasPath は、 |
|
|
statusReplicasPath は、 |
5.2.1.14. .spec.versions[].subresources.status
- 説明
-
CustomResourceSubresourceStatus は、CustomResources のステータスサブリソースを提供する方法を定義します。ステータスは、CustomResource 内の
.status
JSON パスで表されます。設定すると、*カスタムリソースの/status サブリソースを公開します*/status サブリソースへの PUT リクエストはカスタムリソースオブジェクトを取得し、ステータススタンザ以外の変更を無視します*カスタムリソースへの PUT/POST/PATCH リクエストは変更を無視しますステータススタンザ - 型
-
object
5.2.1.15. .status
- 説明
- CustomResourceDefinitionStatus は CustomResourceDefinition の状態を示します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| CustomResourceDefinitionNames は、この CustomResourceDefinition を提供する名前を示します |
|
| 条件は、CustomResourceDefinition の特定の側面の状態を示します |
|
| CustomResourceDefinitionCondition には、この Pod の現在の状態の詳細が含まれています。 |
|
|
storedVersions は、これまでに永続化された CustomResources のすべてのバージョンをリスト表示します。これらのバージョンを追跡すると、etcd に保存されているバージョンの移行パスが可能になります。このフィールドは変更可能であるため、移行コントローラーは別のバージョンへの移行を完了し (古いオブジェクトがストレージに残っていないことを確認)、残りのバージョンをこのリストから削除できます。このリストに存在するバージョンは、 |
5.2.1.16. .status.acceptedNames
- 説明
- CustomResourceDefinitionNames は、この CustomResourceDefinition を提供する名前を示します
- 型
-
object
- 必須
-
複数
-
kind
-
プロパティー | タイプ | 説明 |
---|---|---|
|
|
カテゴリーは、このカスタムリソースが属するグループ化されたリソースのリストです (例: 'すべて')。これは API 検出ドキュメントで公開され、クライアントが |
|
|
kind は、リソースのシリアル化された種類です。通常は CamelCase で単数です。カスタムリソースインスタンスは、この値を API 呼び出しの |
|
| listKind は、このリソースのリストのシリアル化された種類です。デフォルトは "`kind`List" です。 |
|
|
複数形は、提供するリソースの複数形の名前です。カスタムリソースは |
|
|
shortNames はリソースの短縮名であり、API 検出ドキュメントで公開され、クライアントが |
|
|
singular は、リソースの単数名です。すべて小文字である必要があります。デフォルトは小文字 |
5.2.1.17. .status.conditions
- 説明
- 条件は、CustomResourceDefinition の特定の側面の状態を示します
- 型
-
array
5.2.1.18. .status.conditions[]
- 説明
- CustomResourceDefinitionCondition には、この Pod の現在の状態の詳細が含まれています。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。 | |
|
| message は、最後の遷移の詳細を示す人が判読できるメッセージです。 |
|
| 理由は、条件の最後の遷移の一意の 1 単語の CamelCase 理由です。 |
|
| status は、状態のステータスです。True、False、Unknown の場合があります。 |
|
| type は、条件のタイプです。タイプには、Established、NamesAccepted、および Terminating が含まれます。 |
5.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apiextensions.k8s.io/v1/customresourcedefinitions
-
DELETE
:CustomResourceDefinition のコレクションを削除します -
GET
:CustomResourceDefinition の種類のオブジェクトをリスト表示または監視します -
POST
:CustomResourceDefinition を作成します
-
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
-
GET
:CustomResourceDefinition のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
-
削除
:CustomResourceDefinition を削除します -
GET
: 指定された CustomResourceDefinition を読み取ります -
PATCH
: 指定された CustomResourceDefinition を部分的に更新します -
PUT
: 指定された CustomResourceDefinition を置き換えます
-
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
-
GET
:CustomResourceDefinition の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
-
GET
: 指定された CustomResourceDefinition のステータスを読み取ります -
PATCH
: 指定された CustomResourceDefinition のステータスを部分的に更新します -
PUT
: 指定された CustomResourceDefinition のステータスを置き換えます
-
5.2.2.1. /apis/apiextensions.k8s.io/v1/customresourcedefinitions
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CustomResourceDefinition のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- CustomResourceDefinition の種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CustomResourceDefinition を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
5.2.2.2. /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CustomResourceDefinition のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
5.2.2.3. /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CustomResourceDefinition の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CustomResourceDefinition を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された CustomResourceDefinition を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CustomResourceDefinition を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CustomResourceDefinition を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
5.2.2.4. /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CustomResourceDefinition の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CustomResourceDefinition の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
5.2.2.5. /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| CustomResourceDefinition の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された CustomResourceDefinition のステータスを読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CustomResourceDefinition のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CustomResourceDefinition のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
第6章 登録 API
6.1. API 登録 API
6.1.1. APIService [apiregistration.k8s.io/v1]
- 説明
- APIService は、特定の GroupVersion のサーバーを表します。名前は "version.group" である必要があります。
- 型
-
object
6.2. APIService [apiregistration.k8s.io/v1]
- 説明
- APIService は、特定の GroupVersion のサーバーを表します。名前は "version.group" である必要があります。
- 型
-
object
6.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 を参照してください。 | |
|
| APIServiceSpec には、サーバーを見つけて通信するための情報が含まれています。証明書の検証を無効にすることはできますが、https のみがサポートされています。 |
|
| APIServiceStatus には、API サーバーに関する派生情報が含まれています |
6.2.1.1. .spec
- 説明
- APIServiceSpec には、サーバーを見つけて通信するための情報が含まれています。証明書の検証を無効にすることはできますが、https のみがサポートされています。
- 型
-
object
- 必須
-
groupPriorityMinimum
-
versionPriority
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| CABundle は、API サーバーのサービング証明書を検証するために使用される PEM エンコードされた CA バンドルです。指定しない場合、apiserver のシステム信頼ルートが使用されます。 |
|
| Group は、このサーバーがホストする API グループ名です。 |
|
| GroupPriorityMininum は、このグループが少なくとも持つべき優先度です。優先度が高いということは、優先度の低いグループよりもグループがクライアントに優先されることを意味します。このグループの他のバージョンでは、グループ全体の優先度が高くなるように、さらに高い GroupPriorityMininum 値が指定される場合があることに注意してください。プライマリーソートは GroupPriorityMinimum に基づいており、最大数から最小値 (10 の前に 20) の順に並べられます。二次ソートは、オブジェクトの名前のアルファベット順の比較に基づいています。(v1.foo より前の v1.bar) 次のようなものを推奨します:18000 の* .k8s.io (拡張機能を除く) および PaaS(OpenShift、Deis) は 2000 年代に推奨されます |
|
| InsecureSkipTLSVerify は、このサーバーと通信するときに TLS 証明書の検証を無効にします。これは強く推奨しません。代わりに CABundle を使用する必要があります。 |
|
| ServiceReference は、Service.legacy.k8s.io への参照を保持します |
|
| バージョンは、このサーバーがホストする API バージョンです。たとえば、"v1" |
|
| VersionPriority は、グループ内のこの API バージョンの順序を制御します。ゼロより大きくなければなりません。プライマリーソートは VersionPriority に基づいており、最高から最低の順に並べられています (10 の前に 20)。グループ内にあるため、数は少なく、おそらく 10 代になる可能性があります。バージョンの優先度が等しい場合は、バージョン文字列を使用してグループ内の順序を計算します。バージョン文字列が "kube-like" の場合、辞書式順序で並べられた "kube-like" ではないバージョン文字列の上に並べ替えられます。"Kube のような" バージョンは "v" で始まり、その後に数字 (メジャーバージョン) が続き、オプションで文字列 "alpha" または "beta" と別の数字 (マイナーバージョン) が続きます。これらは、最初に GA > ベータ > アルファ (GA はベータやアルファなどの接尾辞のないバージョン) でソートされ、次にメジャーバージョン、次にマイナーバージョンでソートされます。バージョンのソート済みリストの例: v10、v2、v1、v11beta2、v10beta3、v3beta1、v12alpha1、v11alpha2、foo1、foo10。 |
6.2.1.2. .spec.service
- 説明
- ServiceReference は、Service.legacy.k8s.io への参照を保持します
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 名前はサービスの名前です |
|
| 名前空間はサービスの名前空間です |
|
|
指定されている場合、Webhook をホストしているサービスのポート。下位互換性のために、デフォルトは 443 です。 |
6.2.1.3. .status
- 説明
- APIServiceStatus には、API サーバーに関する派生情報が含まれています
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiService の現在のサービス状態。 |
|
| APIServiceCondition は、特定の時点での APIService の状態を表します。 |
6.2.1.4. .status.conditions
- 説明
- apiService の現在のサービス状態。
- 型
-
array
6.2.1.5. .status.conditions[]
- 説明
- APIServiceCondition は、特定の時点での APIService の状態を表します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| 最後にある状態から別の状態に遷移した時間。 | |
|
| 最後にある状態から別の状態に遷移した時間。 |
|
| 条件の最後の遷移の一意の 1 単語の CamelCase 理由。 |
|
| ステータスは、状態のステータスです。True、False、Unknown の場合があります。 |
|
| タイプは条件のタイプです。 |
6.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apiregistration.k8s.io/v1/apiservices
-
DELETE
:APIService のコレクションを削除します -
GET
: 種類 APIService のオブジェクトをリスト表示または監視します -
POST
:APIService を作成します
-
/apis/apiregistration.k8s.io/v1/watch/apiservices
-
GET
:APIService のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apiregistration.k8s.io/v1/apiservices/{name}
-
削除
:APIService を削除します -
GET
: 指定された APIService を読み取ります -
PATCH
: 指定された APIService を部分的に更新します -
PUT
: 指定された APIService を置き換えます
-
/apis/apiregistration.k8s.io/v1/watch/apiservices/{name}
-
GET
: 種類 APIService のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/apiregistration.k8s.io/v1/apiservices/{name}/status
-
GET
: 指定された APIService のステータスを読み取ります -
PATCH
: 指定された APIService のステータスを部分的に更新します -
PUT
: 指定された APIService のステータスを置き換えます
-
6.2.2.1. /apis/apiregistration.k8s.io/v1/apiservices
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- APIService のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- APIService の種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- APIService を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
6.2.2.2. /apis/apiregistration.k8s.io/v1/watch/apiservices
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- APIService のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
6.2.2.3. /apis/apiregistration.k8s.io/v1/apiservices/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| APIService の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- APIService を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された APIService を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された APIService を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された APIService を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
6.2.2.4. /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| APIService の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- APIService の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
6.2.2.5. /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| APIService の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された APIService のステータスを読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された APIService のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された APIService のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第7章 アプリ API
7.1. アプリ API
7.1.1. ControllerRevision [apps/v1]
- 説明
- ControllerRevision は、状態データの不変のスナップショットを実装します。クライアントは、内部状態を含むオブジェクトをシリアル化および逆シリアル化する責任があります。ControllerRevision が正常に作成されると、更新できなくなります。API サーバーは、データフィールドを変更しようとするすべてのリクエストの検証に失敗します。ただし、ControllerRevisions は削除される場合があります。DaemonSet コントローラーと StatefulSet コントローラーの両方で更新とロールバックに使用されるため、このオブジェクトはベータ版であることに注意してください。ただし、将来のリリースで名前と表現が変更される可能性があるため、クライアントはその安定性に依存しないでください。これは主にコントローラーによる内部使用のためのものです。
- 型
-
object
7.1.2. DaemonSet [apps/v1]
- 説明
- DaemonSet は、デーモンセットの設定を表します。
- 型
-
object
7.1.3. Deployment [apps/v1]
- 説明
- デプロイメントにより、Pod と ReplicaSets の宣言型更新が可能になります。
- 型
-
object
7.1.4. ReplicaSet [apps/v1]
- 説明
- ReplicaSet は、指定された数の Pod レプリカが常に実行されていることを確認します。
- 型
-
object
7.1.5. StatefulSet [apps/v1]
- 説明
StatefulSet は、一貫した ID を持つ Pod のセットを表します。ID は次のように定義されます。- ネットワーク: 単一の安定した DNS およびホスト名。- ストレージ: 要求された数の VolumeClaim。
StatefulSet は、特定のネットワーク ID が常に同じストレージ ID にマップされることを保証します。
- 型
-
object
7.2. ControllerRevision [apps/v1]
- 説明
- ControllerRevision は、状態データの不変のスナップショットを実装します。クライアントは、内部状態を含むオブジェクトをシリアル化および逆シリアル化する責任があります。ControllerRevision が正常に作成されると、更新できなくなります。API サーバーは、データフィールドを変更しようとするすべてのリクエストの検証に失敗します。ただし、ControllerRevisions は削除される場合があります。DaemonSet コントローラーと StatefulSet コントローラーの両方で更新とロールバックに使用されるため、このオブジェクトはベータ版であることに注意してください。ただし、将来のリリースで名前と表現が変更される可能性があるため、クライアントはその安定性に依存しないでください。これは主にコントローラーによる内部使用のためのものです。
- 型
-
object
- 必須
-
revision
-
7.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 を参照してください。 | |
|
| リビジョンは、データで表される状態のリビジョンを示します。 |
7.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apps/v1/controllerrevisions
-
GET
: 種類のオブジェクトをリスト表示または監視する ControllerRevision
-
/apis/apps/v1/watch/controllerrevisions
-
GET
: ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/controllerrevisions
-
DELETE
:ControllerRevision のコレクションを削除します -
GET
: 種類のオブジェクトをリスト表示または監視する ControllerRevision -
POST
:ControllerRevision を作成します
-
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
-
GET
: ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
-
削除
:ControllerRevision を削除します -
GET
: 指定された ControllerRevision を読み取ります -
PATCH
: 指定された ControllerRevision を部分的に更新します -
PUT
: 指定された ControllerRevision を置き換えます
-
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
-
GET
:ControllerRevision の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
7.2.2.1. /apis/apps/v1/controllerrevisions
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ControllerRevision の種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
7.2.2.2. /apis/apps/v1/watch/controllerrevisions
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.2.2.3. /apis/apps/v1/namespaces/{namespace}/controllerrevisions
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ControllerRevision のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- ControllerRevision の種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- ControllerRevision を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.2.2.4. /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.2.2.5. /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ControllerRevision の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ControllerRevision を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された ControllerRevision を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された ControllerRevision を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された ControllerRevision を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.2.2.6. /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ControllerRevision の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ControllerRevision の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.3. DaemonSet [apps/v1]
- 説明
- DaemonSet は、デーモンセットの設定を表します。
- 型
-
object
7.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 を参照してください。 | |
|
| DaemonSetSpec は、デーモンセットの仕様です。 |
|
| DaemonSetStatus は、デーモンセットの現在のステータスを表します。 |
7.3.1.1. .spec
- 説明
- DaemonSetSpec は、デーモンセットの仕様です。
- 型
-
object
- 必須
-
selector
-
template
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 新しく作成された DaemonSet Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます)。 |
|
| ロールバックを可能にするために保持する古い履歴の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 10 です。 |
| デーモンセットにより管理される Pod に対するラベルクエリー。制御されるには一致する必要があります。Pod テンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
| 作成される Pod を説明するオブジェクト。DaemonSet は、テンプレートのノードセレクターに一致するすべてのノード (またはノードセレクターが指定されていない場合はすべてのノード) に、この Pod のコピーを 1 つだけ作成する。許可される template.spec.restartPolicy 値は "Always" のみです。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template | |
|
| DaemonSetUpdateStrategy は、DaemonSet の更新戦略を制御するのに使用される構造体です。 |
7.3.1.2. .spec.updateStrategy
- 説明
- DaemonSetUpdateStrategy は、DaemonSet の更新戦略を制御するのに使用される構造体です。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| デーモンセットのローリング更新の望ましい動作を制御するための仕様。 |
|
| デーモンセットの更新のタイプ。"RollingUpdate" または "OnDelete" にすることができます。デフォルトは RollingUpdate です。
使用可能な列挙値: - |
7.3.1.3. .spec.updateStrategy.rollingUpdate
- 説明
- デーモンセットのローリング更新の望ましい動作を制御するための仕様。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| 更新中に更新された DaemonSet Pod を持つことができる既存の利用可能な DaemonSet Pod を持つノードの最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。MaxUnavailable が 0 の場合、これを 0 にすることはできません。絶対数は、最小値 1 に切り上げてパーセンテージから計算されます。デフォルト値は 0 です。例: これが 30% に設定されている場合は、デーモン Pod (つまり status.desiredNumberScheduled) を実行する必要があるノードの総数の最大 30% で、古い Pod が削除済みとしてマークされる前に新しい Pod を作成できます。更新は、ノードの 30% で新しい Pod を起動することから始まります。更新された Pod が利用可能になると (少なくとも minReadySeconds の準備ができたら)、そのノードの古い DaemonSetPod は削除済みとしてマークされます。古い Pod が何らかの理由で使用できなくなった場合 (Ready が false に移行した場合、削除された場合、またはドレイン (解放) された場合)、サージ制限を考慮せずに、更新された Pod がそのノードに即座に作成されます。サージを許可することは、readiness チェックが失敗した場合に任意のノードのデーモンセットによって消費されるリソースが 2 倍になる可能性があることを意味します。したがって、リソースを大量に消費するデーモンセットは、中断中にエビクションを引き起こす可能性があることを考慮に入れる必要があります。 | |
| 更新中に使用できなくなる可能性のある DaemonSet Pod の最大数。値は、絶対数 (例: 5) または更新開始時の DaemonSet Pod の総数のパーセンテージ (例: 10%) にすることができます。絶対数は、端数を切り上げてパーセンテージから計算されます。MaxSurge が 0 の場合、これを 0 にすることはできません。デフォルト値は 1 です。例: これが 30% に設定されている場合は、デーモン Pod (つまり status.desiredNumberScheduled) を実行する必要があるノードの総数の最大 30% で、いつでも更新のために Pod を停止できます。更新は、これらの DaemonSet Pod の最大 30% を停止することから始まり、代わりに新しい DaemonSet Pod を起動します。新しい Pod が使用可能になると、他の DaemonSetPod に進みます。これにより、更新中は常に元の数の DaemonSetPod の 70% 以上が使用可能になります。 |
7.3.1.4. .status
- 説明
- DaemonSetStatus は、デーモンセットの現在のステータスを表します。
- 型
-
object
- 必須
-
currentNumberScheduled
-
numberMisscheduled
-
desiredNumberScheduled
-
numberReady
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| DaemonSet のハッシュ競合の数。DaemonSet コントローラーは、最新の ControllerRevision の名前を作成する必要がある場合に、このフィールドを競合回避メカニズムとして使用します。 |
|
| DaemonSet の現在の状態の最新の利用可能な観測を表します。 |
|
| DaemonSetCondition は、特定の時点での DaemonSet の状態を記述します。 |
|
| 少なくとも 1 つのデーモン Pod を実行していて、デーモン Pod を実行することになっているノードの数。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
|
| デーモン Pod を実行する必要があるノードの総数 (デーモン Pod を正しく実行しているノードを含む)。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
|
| デーモン Pod を実行し、1 つ以上のデーモン Pod を実行して使用可能にする必要があるノードの数 (少なくとも spec.minReadySeconds の準備ができている) |
|
| デーモン Pod を実行しているが、デーモン Pod を実行することは想定されていないノードの数。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
|
| numberReady は、デーモン Pod を実行している必要があり、1 つ以上のデーモン Pod が Ready Condition で実行されているノードの数です。 |
|
| デーモン Pod を実行している必要があり、デーモン Pod が実行されておらず、使用可能になっていないノードの数 (少なくとも spec.minReadySeconds の準備ができている) |
|
| デーモンセットコントローラーによって監視された最新の世代。 |
|
| 更新されたデーモン Pod を実行しているノードの総数 |
7.3.1.5. .status.conditions
- 説明
- DaemonSet の現在の状態の最新の利用可能な観測を表します。
- 型
-
array
7.3.1.6. .status.conditions[]
- 説明
- DaemonSetCondition は、特定の時点での DaemonSet の状態を記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| 最後にある状態から別の状態に遷移した時間。 | |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| DaemonSet 条件のタイプ。 |
7.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apps/v1/daemonsets
-
GET
: DaemonSet 種類のオブジェクトをリスト表示または監視する
-
/apis/apps/v1/watch/daemonsets
-
GET
: DaemonSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/daemonsets
-
DELETE
: DaemonSet のコレクションを削除する -
GET
: DaemonSet 種類のオブジェクトをリスト表示または監視する -
POST
:DaemonSet を作成する
-
/apis/apps/v1/watch/namespaces/{namespace}/daemonsets
-
GET
: DaemonSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
-
DELETE
: DaemonSet を削除する -
GET
: 指定された DaemonSet を読み取る -
PATCH
: 指定された DaemonSet を部分的に更新する -
PUT
: 指定された DaemonSet を置き換える
-
/apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}
-
GET
: DaemonSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
-
GET
: 指定された DaemonSet のステータスを読み取る -
PATCH
: 指定された DaemonSet のステータスを部分的に更新します -
PUT
: 指定された DaemonSet のステータスを置き換える
-
7.3.2.1. /apis/apps/v1/daemonsets
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- DaemonSet 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.3.2.2. /apis/apps/v1/watch/daemonsets
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- DaemonSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.3.2.3. /apis/apps/v1/namespaces/{namespace}/daemonsets
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- DaemonSet のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- DaemonSet 種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- DaemonSet を作成します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.3.2.4. /apis/apps/v1/watch/namespaces/{namespace}/daemonsets
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- DaemonSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.3.2.5. /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| DaemonSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- DaemonSet を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された DaemonSet を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された DaemonSet を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された DaemonSet を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.3.2.6. /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| DaemonSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- DaemonSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.3.2.7. /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| DaemonSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された DaemonSet のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された DaemonSet のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された DaemonSet のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.4. Deployment [apps/v1]
- 説明
- デプロイメントにより、Pod と ReplicaSets の宣言型更新が可能になります。
- 型
-
object
7.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 を参照してください。 | |
|
| DeploymentSpec は、デプロイメントの望ましい動作の仕様です。 |
|
| DeploymentStatus は、Deployment の最後に観察されたステータスです。 |
7.4.1.1. .spec
- 説明
- DeploymentSpec は、デプロイメントの望ましい動作の仕様です。
- 型
-
object
- 必須
-
selector
-
template
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 新しく作成された Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます) |
|
| デプロイメントが一時停止されていることを示します。 |
|
| デプロイメントが失敗したと見なされる前に、デプロイメントが進行するまでの最大時間 (秒単位)。デプロイメントコントローラーは失敗したデプロイメントの処理を続行し、ProgressDeadlineExceeded 理由のある条件がデプロイメントステータスに表示されます。デプロイメントが一時停止している間は、進行状況は推定されないことに注意してください。デフォルトは 600 秒です。 |
|
| 必要な Pod の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。 |
|
| ロールバックを可能にするために保持する古い ReplicaSet の数。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 10 です。 |
| Pod のラベルセレクター。これによって Pod が選択される既存の ReplicaSet は、このデプロイメントの影響を受けるものになります。Pod テンプレートのラベルと一致する必要があります。 | |
|
| DeploymentStrategy は、既存の Pod を新しい Pod に置き換える方法を説明しています。 |
| テンプレートには、作成される Pod が記述されています。許可される template.spec.restartPolicy 値は "Always" のみです。 |
7.4.1.2. .spec.strategy
- 説明
- DeploymentStrategy は、既存の Pod を新しい Pod に置き換える方法を説明しています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| ローリング更新の望ましい動作を制御するための仕様。 |
|
| デプロイメントのタイプ。"Recreate" または "RollingUpdate" にすることができます。デフォルトは RollingUpdate です。
使用可能な列挙値: - |
7.4.1.3. .spec.strategy.rollingUpdate
- 説明
- ローリング更新の望ましい動作を制御するための仕様。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| 希望する Pod 数を超えてスケジュールできる Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。MaxUnavailable が 0 の場合、これを 0 にすることはできません。絶対数は、端数を切り上げてパーセンテージから計算されます。デフォルトは 25% です。例: これが 30% に設定されている場合、ローリング更新の開始時に新しい ReplicaSet をすぐにスケールアップして、新旧の Pod の総数が目的の Pod の 130% を超えないようにすることができます。古い Pod が強制終了されると、新しい ReplicaSet をさらにスケールアップして、更新中にいつでも実行されている Pod の総数が目的の Pod の最大 130% になるようにすることができます。 | |
| 更新中に使用できなくなる可能性のある Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。絶対数は、端数を切り捨ててパーセンテージから計算されます。MaxSurge が 0 の場合、これを 0 にすることはできません。デフォルトは 25% です。例: これが 30% に設定されている場合、ローリング更新が開始されるとすぐに、古い ReplicaSet を目的の Pod の 70% に縮小できます。新しい Pod の準備ができたら、古い ReplicaSet をさらにスケールダウンしてから、新しい ReplicaSet をスケールアップして、更新中に常に使用可能な Pod の総数が目的の Pod の少なくとも 70% になるようにします。 |
7.4.1.4. .status
- 説明
- DeploymentStatus は、Deployment の最後に観察されたステータスです。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| このデプロイメントの対象となる利用可能な Pod の総数 (少なくとも minReadySeconds の準備ができています)。 |
|
| Deployment のハッシュ競合の数。Deployment コントローラーは、最新の ReplicaSet の名前を作成する必要がある場合に、このフィールドを競合回避メカニズムとして使用します。 |
|
| デプロイメントの現在の状態の最新の利用可能な観測を表します。 |
|
| DeploymentCondition は、特定の時点でのデプロイメントの状態を記述します。 |
|
| デプロイメントコントローラーにより監視される世代。 |
|
| readyReplicas は、このデプロイの対象となる Ready Condition 状態の Pod の数です。 |
|
| このデプロイメントの対象となる非終了 Pod の総数 (ラベルはセレクターと一致します)。 |
|
| このデプロイメントの対象となる使用できない Pod の総数。これは、デプロイメントで 100% の使用可能な容量を確保するために必要な Pod の総数です。それらは、実行されているがまだ利用できない Pod か、まだ作成されていない Pod のいずれかです。 |
|
| 目的のテンプレート仕様を持つ、このデプロイメントの対象となる非終了 Pod の総数。 |
7.4.1.5. .status.conditions
- 説明
- デプロイメントの現在の状態の最新の利用可能な観測を表します。
- 型
-
array
7.4.1.6. .status.conditions[]
- 説明
- DeploymentCondition は、特定の時点でのデプロイメントの状態を記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| 最後にある状態から別の状態に遷移した時間。 | |
| この状態が最後に更新された時刻。 | |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| デプロイメント条件のタイプ。 |
7.4.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apps/v1/deployments
-
GET
: Deployment 種類のオブジェクトをリスト表示または監視する
-
/apis/apps/v1/watch/deployments
-
GET
: Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/deployments
-
DELETE
: Deployment のコレクションを削除する -
GET
: Deployment 種類のオブジェクトをリスト表示または監視する -
POST
: Deployment を作成する
-
/apis/apps/v1/watch/namespaces/{namespace}/deployments
-
GET
: Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/deployments/{name}
-
DELETE
: Deployment を削除する -
GET
: 指定された Deployment を読み取る -
PATCH
: 指定された Deployment を部分的に更新する -
PUT
: 指定されたデプロイメントを置き換える
-
/apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}
-
GET
: Deployment 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
-
GET
: 指定されたデプロイメントのステータスを読み取る -
PATCH
: 指定された Deployment のステータスを部分的に更新する -
PUT
: 指定された Deployment のステータスを置き換える
-
7.4.2.1. /apis/apps/v1/deployments
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Deployment 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.4.2.2. /apis/apps/v1/watch/deployments
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.4.2.3. /apis/apps/v1/namespaces/{namespace}/deployments
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- Deployment のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- Deployment 種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- デプロイメントを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.4.2.4. /apis/apps/v1/watch/namespaces/{namespace}/deployments
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Deployment のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.4.2.5. /apis/apps/v1/namespaces/{namespace}/deployments/{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
- 説明
- 指定された Deployment を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Deployment を読み込む。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.4.2.6. /apis/apps/v1/watch/namespaces/{namespace}/deployments/{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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Deployment 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.4.2.7. /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| デプロイメントの名前。 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された Deployment のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Deployment のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された Deployment のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.5. ReplicaSet [apps/v1]
- 説明
- ReplicaSet は、指定された数の Pod レプリカが常に実行されていることを確認します。
- 型
-
object
7.5.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| ReplicaSet のラベルが空の場合、デフォルトでは、ReplicaSet が管理する Pod と同じになります。標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| ReplicaSetSpec は、ReplicaSet の仕様です。 |
|
| ReplicaSetStatus は、ReplicaSet の現在のステータスを表します。 |
7.5.1.1. .spec
- 説明
- ReplicaSetSpec は、ReplicaSet の仕様です。
- 型
-
object
- 必須
-
selector
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 新しく作成された Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます) |
|
| レプリカは、必要なレプリカの数です。これは、明示的なゼロと指定されていないものを区別するためのポインターです。デフォルトは 1 です。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| Selector は、レプリカ数と一致する必要がある Pod に対するラベルクエリーです。このレプリカセットによって制御されるために一致する必要があるキーと値にラベルを付けます。Pod テンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
| テンプレートは、不十分なレプリカが検出された場合に作成される Pod を説明するオブジェクトです。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
7.5.1.2. .status
- 説明
- ReplicaSetStatus は、ReplicaSet の現在のステータスを表します。
- 型
-
object
- 必須
-
replicas
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| このレプリカセットで使用可能なレプリカの数 (少なくとも minReadySeconds の準備ができています)。 |
|
| レプリカセットの現在の状態の最新の利用可能な観察値を表します。 |
|
| ReplicaSetCondition は、特定の時点でのレプリカセットの状態を記述します。 |
|
| レプリカセットの Pod テンプレートのラベルと一致するラベルを持つ Pod の数。 |
|
| ObservedGeneration は、最後に観察された ReplicaSet の生成を反映します。 |
|
| readyReplicas は、Ready Condition のこの ReplicaSet によってターゲットに設定された Pod 数です。 |
|
| レプリカは、最近観察されたレプリカの数です。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
7.5.1.3. .status.conditions
- 説明
- レプリカセットの現在の状態の最新の利用可能な観察値を表します。
- 型
-
array
7.5.1.4. .status.conditions[]
- 説明
- ReplicaSetCondition は、特定の時点でのレプリカセットの状態を記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| 最後にある状態から別の状態に遷移した時間。 | |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| レプリカセット条件のタイプ。 |
7.5.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apps/v1/replicasets
-
GET
: ReplicaSet 種類のオブジェクトをリスト表示または監視します
-
/apis/apps/v1/watch/replicasets
-
GET
: ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/replicasets
-
DELETE
: ReplicaSet のコレクションを削除する -
GET
: ReplicaSet 種類のオブジェクトをリスト表示または監視します -
POST
: ReplicaSet を作成する
-
/apis/apps/v1/watch/namespaces/{namespace}/replicasets
-
GET
: ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}
-
DELETE
: ReplicaSet を削除する -
GET
: 指定された ReplicaSet を読み取る -
PATCH
: 指定された ReplicaSet を部分的に更新する -
PUT
: 指定された ReplicaSet を置き換える
-
/apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}
-
GET
: ReplicaSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
-
GET
: 指定された ReplicaSet のステータスを読み取る -
PATCH
: 指定された ReplicaSet のステータスを部分的に更新する -
PUT
: 指定された ReplicaSet のステータスを置き換える
-
7.5.2.1. /apis/apps/v1/replicasets
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ReplicaSet 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.5.2.2. /apis/apps/v1/watch/replicasets
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.5.2.3. /apis/apps/v1/namespaces/{namespace}/replicasets
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ReplicaSet のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- ReplicaSet 種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- ReplicaSet を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.5.2.4. /apis/apps/v1/watch/namespaces/{namespace}/replicasets
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.5.2.5. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ReplicaSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ReplicaSet を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された ReplicaSet を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された ReplicaSet を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された ReplicaSet を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.5.2.6. /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ReplicaSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ReplicaSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.5.2.7. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| ReplicaSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された ReplicaSet のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された ReplicaSet のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された ReplicaSet のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.6. StatefulSet [apps/v1]
- 説明
StatefulSet は、一貫した ID を持つ Pod のセットを表します。ID は次のように定義されます。- ネットワーク: 単一の安定した DNS およびホスト名。- ストレージ: 要求された数の VolumeClaim。
StatefulSet は、特定のネットワーク ID が常に同じストレージ ID にマップされることを保証します。
- 型
-
object
7.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 を参照してください。 | |
|
| StatefulSetSpec は、StatefulSet の仕様です。 |
|
| StatefulSetStatus は、StatefulSet の現在の状態を表します。 |
7.6.1.1. .spec
- 説明
- StatefulSetSpec は、StatefulSet の仕様です。
- 型
-
object
- 必須
-
selector
-
template
-
serviceName
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 新しく作成された Pod が使用可能であると見なされるために、コンテナーがクラッシュすることなく準備ができる最小秒数。デフォルトは 0 です (Pod は準備ができ次第利用可能と見なされます) |
|
| StatefulSetOrdinals は、この StatefulSet でのレプリカ順序割り当てに使用されるポリシーを記述します。 |
|
| StatefulSetPersistentVolumeClaimRetentionPolicy は、StatefulSet VolumeClaimTemplate から作成された PVC に使用されるポリシーを記述します。 |
|
|
podManagementPolicy は、初期スケールアップ時、ノード上の Pod の交換時、またはスケールダウン時に Pod を作成する方法を制御します。デフォルトのポリシーは
使用可能な列挙値: - |
|
| レプリカは、指定した Template のレプリカの希望する数です。これらは、同じ Template のインスタンス化であるという意味でレプリカですが、個々のレプリカにも一貫した ID があります。指定しない場合、デフォルトは 1 です。 |
|
| revisionHistoryLimit は、StatefulSet のリビジョン履歴に保持されるリビジョンの最大数です。リビジョン履歴は、現在適用されている StatefulSetSpec バージョンで表されていないすべてのリビジョンで構成されます。デフォルト値は 10 です。 |
| selector は、レプリカ数と一致する必要がある Pod に対するラベルクエリーです。Pod テンプレートのラベルと一致する必要があります。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
| serviceName は、この StatefulSet を管理するサービスの名前です。このサービスは StatefulSet の前に存在する必要があり、セットのネットワーク ID を担当します。Pod は、pod-specific-string.serviceName.default.svc.cluster.local のパターンに従う DNS/ホスト名を取得します。ここで、"pod-specific-string" は StatefulSet コントローラーによって管理されます。 |
| テンプレートは、不十分なレプリカが検出された場合に作成される Pod を説明するオブジェクトです。StatefulSet によりスタンプされた各 Pod はこのテンプレートを満たしますが、StatefulSet の残りの部分とは異なる一意の ID を持ちます。各 Pod には、<statefulsetname>-<podindex> の形式で名前が付けられます。たとえば、インデックス番号 "3" を持つ "web" という名前の StatefulSet 内の Pod は、"web-3" という名前になります。許可される template.spec.restartPolicy 値は "Always" のみです。 | |
|
| StatefulSetUpdateStrategy は、StatefulSet コントローラーが更新を実行するのに使用する戦略を示します。示された戦略の更新を実行するのに必要な追加のパラメーターが含まれています。 |
| volumeClaimTemplates は、Pod が参照できるクレームのリストです。StatefulSet コントローラーは、Pod の ID を維持する方法で、ネットワーク ID をクレームにマッピングするロールを果たします。このリストのすべてのクレームには、テンプレートの 1 つのコンテナーに (名前で) 一致する volumeMount が 1 つ以上含まれている必要があります。このリストのクレームは、同じ名前のテンプレート内のどのボリュームよりも優先されます。 |
7.6.1.2. .spec.ordinals
- 説明
- StatefulSetOrdinals は、この StatefulSet でのレプリカ順序割り当てに使用されるポリシーを記述します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| start は、最初のレプリカのインデックスを表す番号です。これを使用すると、デフォルトの 0 から始まるインデックス名ではなく、別のインデックス (例: 1 から始まるインデックス) からレプリカに番号を付けるか、別の StatefulSet へのレプリカの段階的な移動をオーケストレーションすることができます。設定されている場合、レプリカインデックスは .spec.ordinals.start、.spec.ordinals.start + .spec.replicas) の範囲になります。設定されていない場合、デフォルトは 0 です。レプリカのインデックスは [0、.spec.replicas) の範囲になります。 |
7.6.1.3. .spec.persistentVolumeClaimRetentionPolicy
- 説明
- StatefulSetPersistentVolumeClaimRetentionPolicy は、StatefulSet VolumeClaimTemplate から作成された PVC に使用されるポリシーを記述します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
|
WhenDeleted は、StatefulSet が削除されたときに、StatefulSet VolumeClaimTemplates から作成された PVC に何が起こるかを指定します。 |
|
|
WhenScaled は、StatefulSet がスケールダウンされたときに StatefulSet VolumeClaimTemplates から作成された PVC に何が起こるかを指定します。 |
7.6.1.4. .spec.updateStrategy
- 説明
- StatefulSetUpdateStrategy は、StatefulSet コントローラーが更新を実行するのに使用する戦略を示します。示された戦略の更新を実行するのに必要な追加のパラメーターが含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| RollingUpdateStatefulSetStrategy は、RollingUpdateStatefulSetStrategyType のパラメーターを伝達するのに使用されます。 |
|
| タイプは、StatefulSetUpdateStrategy のタイプを示します。デフォルトは RollingUpdate です。
可能な列挙値: - |
7.6.1.5. .spec.updateStrategy.rollingUpdate
- 説明
- RollingUpdateStatefulSetStrategy は、RollingUpdateStatefulSetStrategyType のパラメーターを伝達するのに使用されます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| 更新中に使用できなくなる可能性のある Pod の最大数。値は、絶対数 (例:5) または目的の Pod のパーセンテージ (例:10%) にすることができます。絶対数は、端数を切り上げてパーセンテージから計算されます。これは 0 にすることはできません。デフォルトは 1 です。このフィールドはアルファレベルであり、MaxUnavailableStatefulSet 機能を有効にするサーバーでのみ認識されます。このフィールドは、0 から Replicas-1 の範囲内のすべての Pod に適用されます。つまり、0 から Replicas-1 までの範囲内に使用できない Pod がある場合は、MaxUnavailable にカウントされます。 | |
|
| Partition は、StatefulSet をパーティション分割して更新する序数を示します。ローリング更新時に、通常の Replicas-1 からパーティションへのすべての Pod が更新されます。パーティション 1 から 0 までの Pod はどれも変更されません。これは、カナリアベースのデプロイメントを実行できるようにするのに役立ちます。デフォルト値は 0 です。 |
7.6.1.6. .status
- 説明
- StatefulSetStatus は、StatefulSet の現在の状態を表します。
- 型
-
object
- 必須
-
replicas
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| この statefulset の対象となる利用可能な Pod (少なくとも minReadySeconds の準備ができている) の総数。 |
|
| collisionCount は、StatefulSet のハッシュ競合の数です。StatefulSet コントローラーは、最新の ControllerRevision の名前を作成する必要がある場合に、このフィールドを競合回避メカニズムとして使用します。 |
|
| statefulset の現在の状態の最新の利用可能な観測値を表します。 |
|
| StatefulSetCondition は、特定の時点での statefulset の状態を記述します。 |
|
| currentReplicas は、currentRevision により示される StatefulSet バージョンから StatefulSet コントローラーによって作成された Pod の数です。 |
|
| currentRevision は、空でない場合、シーケンス [0,currentReplicas) で Pod を生成するのに使用される StatefulSet のバージョンを示します。 |
|
| observedGeneration は、この StatefulSet で観察された最新の世代です。これは、API サーバーによる変更時に更新される StatefulSet の生成に対応します。 |
|
| readyReplicas は、Ready 条件が指定されたこの StatefulSet に対して作成された Pod の数です。 |
|
| レプリカは、StatefulSet コントローラーによって作成された Pod の数です。 |
|
| updateRevision は、空でないと、シーケンス [replicas-updatedReplicas,replicas) で Pod を生成するのに使用される StatefulSet のバージョンを示します。 |
|
| updatedReplicas は、updateRevision により示される StatefulSet バージョンから StatefulSet コントローラーにより作成された Pod の数です。 |
7.6.1.7. .status.conditions
- 説明
- statefulset の現在の状態の最新の利用可能な観測値を表します。
- 型
-
array
7.6.1.8. .status.conditions[]
- 説明
- StatefulSetCondition は、特定の時点での statefulset の状態を記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| 最後にある状態から別の状態に遷移した時間。 | |
|
| 遷移の詳細を示す人が判読できるメッセージ。 |
|
| 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| statefulset 条件のタイプ。 |
7.6.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apps/v1/statefulsets
-
GET
: StatefulSet 種類のオブジェクトをリスト表示または監視する
-
/apis/apps/v1/watch/statefulsets
-
GET
: StatefulSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets
-
DELETE
: StatefulSet のコレクションを削除する -
GET
: StatefulSet 種類のオブジェクトをリスト表示または監視する -
POST
: StatefulSet を作成する
-
/apis/apps/v1/watch/namespaces/{namespace}/statefulsets
-
GET
: StatefulSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
-
DELETE
: StatefulSet を削除する -
GET
: 指定された StatefulSet を読み取る -
PATCH
: 指定された StatefulSet を部分的に更新する -
PUT
: 指定された StatefulSet を置き換える
-
/apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}
-
GET
: StatefulSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
-
GET
: 指定された StatefulSet のステータスを読み取ります。 -
PATCH
: 指定された StatefulSet のステータスを部分的に更新します。 -
PUT
: 指定された StatefulSet のステータスを置き換えます。
-
7.6.2.1. /apis/apps/v1/statefulsets
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- StatefulSet 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.6.2.2. /apis/apps/v1/watch/statefulsets
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- StatefulSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.6.2.3. /apis/apps/v1/namespaces/{namespace}/statefulsets
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- StatefulSet のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- StatefulSet 種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- StatefulSet を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
7.6.2.4. /apis/apps/v1/watch/namespaces/{namespace}/statefulsets
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- StatefulSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.6.2.5. /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| StatefulSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- StatefulSet を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された StatefulSet を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StatefulSet を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StatefulSet を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
7.6.2.6. /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| StatefulSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- StatefulSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
7.6.2.7. /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| StatefulSet の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された StatefulSet のステータスを読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された StatefulSet のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された StatefulSet のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第8章 認証 API
8.1. 認証 API
8.1.1. TokenRequest [authentication.k8s.io/v1]
- 説明
- TokenRequest は、指定のサービスアカウントのトークンを要求します。
- 型
-
object
8.1.2. TokenReview [authentication.k8s.io/v1]
- 説明
- TokenReview は、既知のユーザーに対してトークンを認証します。注: TokenReview 要求は、kube-apiserver の webhook トークンオーセンティケータープラグインによりキャッシュされる場合があります。
- 型
-
object
8.2. TokenRequest [authentication.k8s.io/v1]
- 説明
- TokenRequest は、指定のサービスアカウントのトークンを要求します。
- 型
-
object
- 必須
-
spec
-
8.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 を参照してください。 | |
|
| TokenRequestSpec には、トークンリクエストのクライアント提供パラメーターが含まれています。 |
|
| TokenRequestStatus は、トークンリクエストの結果です。 |
8.2.1.1. .spec
- 説明
- TokenRequestSpec には、トークンリクエストのクライアント提供パラメーターが含まれています。
- 型
-
object
- 必須
-
audiences
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| audiences は、トークンのオーディエンスです。トークンの受信者は、トークンのオーディエンスリストにある識別子を使用して自身を識別する必要があり、そうでない場合はトークンを拒否する必要があります。複数のオーディエンスに対して発行されたトークンは、リストされているオーディエンスのいずれかに対して認証するために使用できますが、ターゲットオーディエンス間の高度な信頼を意味します。 |
|
| boundObjectReference は、トークンがバインドされているオブジェクトへの参照です。 |
|
| expirationSeconds は、リクエストされた要求の有効期間です。トークン発行者は、有効期間が異なるトークンを返す可能性があるため、クライアントは応答の 'expiration' フィールドを確認する必要があります。 |
8.2.1.2. .spec.boundObjectRef
- 説明
- boundObjectReference は、トークンがバインドされているオブジェクトへの参照です。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| 参照先の種類。有効な種類は 'Pod' と 'Secret' です。 |
|
| 参照先の名前。 |
|
| 参照先の UID。 |
8.2.1.3. .status
- 説明
- TokenRequestStatus は、トークンリクエストの結果です。
- 型
-
object
- 必須
-
token
-
expirationTimestamp
-
プロパティー | タイプ | 説明 |
---|---|---|
| expirationTimestamp は、返されたトークンの有効期限です。 | |
|
| token は不透明なベアラトークンです。 |
8.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/namespaces/{namespace}/serviceaccounts/{name}/token
-
POST
: ServiceAccount のトークンを作成する
-
8.2.2.1. /api/v1/namespaces/{namespace}/serviceaccounts/{name}/token
パラメーター | 型 | 説明 |
---|---|---|
|
| TokenRequest の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- ServiceAccount のトークンを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
8.3. TokenReview [authentication.k8s.io/v1]
- 説明
- TokenReview は、既知のユーザーに対してトークンを認証します。注: TokenReview 要求は、kube-apiserver の webhook トークンオーセンティケータープラグインによりキャッシュされる場合があります。
- 型
-
object
- 必須
-
spec
-
8.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 を参照してください。 | |
|
| TokenReviewSpec は、トークン認証リクエストの説明です。 |
|
| TokenReviewStatus は、トークン認証リクエストの結果です。 |
8.3.1.1. .spec
- 説明
- TokenReviewSpec は、トークン認証リクエストの説明です。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| audiences は、トークンとともに提示されたリソースサーバーが識別する識別子のリストです。オーディエンス対応のトークンオーセンティケーターは、トークンがこのリストの少なくとも 1 つのオーディエンスを対象としていることを確認します。audiences が提供されていないと、オーディエンスはデフォルトで Kubernetes apiserver のオーディエンスになります。 |
|
| token は不透明なベアラトークンです。 |
8.3.1.2. .status
- 説明
- TokenReviewStatus は、トークン認証リクエストの結果です。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| audiences は、TokenReview とトークンの両方と互換性のあるオーセンティケーターによって選択されたオーディエンス識別子です。識別子は、TokenReviewSpec オーディエンスとトークンのオーディエンスの共通部分にある識別子です。spec.audiences フィールドを設定する TokenReview API のクライアントは、互換性のあるオーディエンス識別子が status.audiences フィールドに返されることを検証して、TokenReview サーバーがオーディエンスを認識していることを確認する必要があります。TokenReview が status.authenticated が "true" である空の status.audience フィールドを返す場合は、トークンが Kubernetes API サーバーのオーディエンスに対して有効です。 |
|
| authenticated は、トークンが既知のユーザーに関連付けられていることを示します。 |
|
| error は、トークンをチェックできなかったことを示します |
|
| userInfo は、user.Info インターフェイスを実装するのに必要なユーザーに関する情報を保持します。 |
8.3.1.3. .status.user
- 説明
- userInfo は、user.Info インターフェイスを実装するのに必要なユーザーに関する情報を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| オーセンティケーターから提供される追加情報。 |
|
| |
|
| このユーザーが参加しているグループの名前。 |
|
| 時間の経過とともにこのユーザーを識別する一意の値。このユーザーが削除され、同じ名前の別のユーザーが追加されると、UID は異なります。 |
|
| すべてのアクティブユーザーの中でこのユーザーを一意に識別する名前。 |
8.3.1.4. .status.user.extra
- 説明
- オーセンティケーターから提供される追加情報。
- 型
-
object
8.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/authentication.k8s.io/v1/tokenreviews
-
POST
:TokenReview を作成します
-
8.3.2.1. /apis/authentication.k8s.io/v1/tokenreviews
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- TokenReview を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
第9章 Authorization APIs
9.1. Authorization APIs
9.1.1. LocalSubjectAccessReview [authorization.k8s.io/v1]
- 説明
- LocalSubjectAccessReview は、ユーザーまたはグループが特定の namespace でアクションを実行できるかどうかを確認します。namespace のスコープ指定されたリソースがあると、パーミッションチェックを含む namespace のスコープ指定されたポリシーの付与がはるかに容易になります。
- 型
-
object
9.1.2. SelfSubjectAccessReview [authorization.k8s.io/v1]
- 説明
- SelfSubjectAccessReview は、現在のユーザーがアクションを実行できるかどうかを確認します。spec.namespace に入力しない場合は、"すべての namespace 内" を意味します。ユーザーは常にアクションを実行できるかどうかを確認できる必要があるため、Self は特殊なケースです。
- 型
-
object
9.1.3. SelfSubjectRulesReview [authorization.k8s.io/v1]
- 説明
- SelfSubjectRulesReview は、現在のユーザーが namespace 内で実行できるアクションのセットを列挙します。サーバーの認証モード、および評価中に発生したエラーに応じて、返されるアクションのリストが不完全な場合があります。SelfSubjectRulesReview は、UI でアクションを表示/非表示にしたり、エンドユーザーにパーミッションに関する理由を素早く伝えたりするために使用します。これは、代理人の混乱、キャッシュの有効期限/失効、および正確性の懸念を引き起こすため、承認の決定を推進するために外部システムに使用されるべきではありません。SubjectAccessReview および LocalAccessReview は、API サーバーへの承認決定を遅らせる正しい方法です。
- 型
-
object
9.1.4. SubjectAccessReview [authorization.k8s.io/v1]
- 説明
- SubjectAccessReview は、ユーザーまたはグループがアクションを実行できるかどうかをチェックします。
- 型
-
object
9.2. LocalSubjectAccessReview [authorization.k8s.io/v1]
- 説明
- LocalSubjectAccessReview は、ユーザーまたはグループが特定の namespace でアクションを実行できるかどうかを確認します。namespace のスコープ指定されたリソースがあると、パーミッションチェックを含む namespace のスコープ指定されたポリシーの付与がはるかに容易になります。
- 型
-
object
- 必須
-
spec
-
9.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 を参照してください。 | |
|
| SubjectAccessReviewSpec は、アクセス要求の説明です。ResourceAuthorizationAttributes と NonResourceAuthorizationAttributes のいずれかを設定する必要があります。 |
|
| SubjectAccessReviewStatus |
9.2.1.1. .spec
- 説明
- SubjectAccessReviewSpec は、アクセス要求の説明です。ResourceAuthorizationAttributes と NonResourceAuthorizationAttributes のいずれかを設定する必要があります。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| extra は、オーセンティケーターの user.Info.GetExtra() メソッドに対応します。これは Authorizer に入力されるため、ここで反映する必要があります。 |
|
| |
|
| groups は、テストしているグループです。 |
|
| nonResourceAttributes には、Authorizer インターフェイスへの非リソース要求に使用できる許可属性が含まれています。 |
|
| resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています。 |
|
| 要求しているユーザーに関する UID 情報。 |
|
| user は、テストしているユーザーです。"user" を指定し、"groups" を指定しない場合は、「そのユーザーがどのグループにも所属していなかったらどうなるか」という意味になります。 |
9.2.1.2. .spec.extra
- 説明
- extra は、オーセンティケーターの user.Info.GetExtra() メソッドに対応します。これは Authorizer に入力されるため、ここで反映する必要があります。
- 型
-
object
9.2.1.3. .spec.nonResourceAttributes
- 説明
- nonResourceAttributes には、Authorizer インターフェイスへの非リソース要求に使用できる許可属性が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| path はリクエストの URL パスです。 |
|
| verb は標準の HTTP 動詞です。 |
9.2.1.4. .spec.resourceAttributes
- 説明
- resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| グループは、リソースの API グループです。"*" はすべてを意味します。 |
|
| name は、"取得" のために要求されているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。 |
|
| namespace は、要求されているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。 |
|
| resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。 |
|
| subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。 |
|
| verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。 |
|
| バージョンは、リソースの API バージョンです。"*" はすべてを意味します。 |
9.2.1.5. .status
- 説明
- SubjectAccessReviewStatus
- 型
-
object
- 必須
-
allowed
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| allowed は必須です。アクションを許可する場合は true、許可しない場合は false です。 |
|
| denied はオプションです。アクションを拒否する場合は true、許可しない場合は false です。allowed と denied の両方が false の場合は、Authorizer がアクションを許可するかどうかについて意見を持っていません。allowed が true の場合は、denied が true ではない可能性があります。 |
|
| evaluationError は、認可チェック中にエラーが発生したことを示します。エラーが発生し、それにもかかわらず認可ステータスを判別し続けることはできます。たとえば、RBAC にロールがない可能性がありますが、十分なロールがまだ存在しており、要求の理由に拘束されています。 |
|
| reason はオプションです。リクエストが許可または拒否された理由を示します。 |
9.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
-
POST
: LocalSubjectAccessReview を作成する
-
9.2.2.1. /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- LocalSubjectAccessReview を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
9.3. SelfSubjectAccessReview [authorization.k8s.io/v1]
- 説明
- SelfSubjectAccessReview は、現在のユーザーがアクションを実行できるかどうかを確認します。spec.namespace に入力しない場合は、"すべての namespace 内" を意味します。ユーザーは常にアクションを実行できるかどうかを確認できる必要があるため、Self は特殊なケースです。
- 型
-
object
- 必須
-
spec
-
9.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 を参照してください。 | |
|
| SelfSubjectAccessReviewSpec は、アクセス要求の説明です。ResourceAuthorizationAttributes と NonResourceAuthorizationAttributes のいずれかを設定する必要があります。 |
|
| SubjectAccessReviewStatus |
9.3.1.1. .spec
- 説明
- SelfSubjectAccessReviewSpec は、アクセス要求の説明です。ResourceAuthorizationAttributes と NonResourceAuthorizationAttributes のいずれかを設定する必要があります。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| nonResourceAttributes には、Authorizer インターフェイスへの非リソース要求に使用できる許可属性が含まれています。 |
|
| resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています。 |
9.3.1.2. .spec.nonResourceAttributes
- 説明
- nonResourceAttributes には、Authorizer インターフェイスへの非リソース要求に使用できる許可属性が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| path はリクエストの URL パスです。 |
|
| verb は標準の HTTP 動詞です。 |
9.3.1.3. .spec.resourceAttributes
- 説明
- resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| グループは、リソースの API グループです。"*" はすべてを意味します。 |
|
| name は、"取得" のために要求されているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。 |
|
| namespace は、要求されているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。 |
|
| resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。 |
|
| subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。 |
|
| verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。 |
|
| バージョンは、リソースの API バージョンです。"*" はすべてを意味します。 |
9.3.1.4. .status
- 説明
- SubjectAccessReviewStatus
- 型
-
object
- 必須
-
allowed
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| allowed は必須です。アクションを許可する場合は true、許可しない場合は false です。 |
|
| denied はオプションです。アクションを拒否する場合は true、許可しない場合は false です。allowed と denied の両方が false の場合は、Authorizer がアクションを許可するかどうかについて意見を持っていません。allowed が true の場合は、denied が true ではない可能性があります。 |
|
| evaluationError は、認可チェック中にエラーが発生したことを示します。エラーが発生し、それにもかかわらず認可ステータスを判別し続けることはできます。たとえば、RBAC にロールがない可能性がありますが、十分なロールがまだ存在しており、要求の理由に拘束されています。 |
|
| reason はオプションです。リクエストが許可または拒否された理由を示します。 |
9.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/authorization.k8s.io/v1/selfsubjectaccessreviews
-
POST
: SelfSubjectAccessReview を作成する
-
9.3.2.1. /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- SelfSubjectAccessReview を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
9.4. SelfSubjectRulesReview [authorization.k8s.io/v1]
- 説明
- SelfSubjectRulesReview は、現在のユーザーが namespace 内で実行できるアクションのセットを列挙します。サーバーの認証モード、および評価中に発生したエラーに応じて、返されるアクションのリストが不完全な場合があります。SelfSubjectRulesReview は、UI でアクションを表示/非表示にしたり、エンドユーザーにパーミッションに関する理由を素早く伝えたりするために使用します。これは、代理人の混乱、キャッシュの有効期限/失効、および正確性の懸念を引き起こすため、承認の決定を推進するために外部システムに使用されるべきではありません。SubjectAccessReview および LocalAccessReview は、API サーバーへの承認決定を遅らせる正しい方法です。
- 型
-
object
- 必須
-
spec
-
9.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 を参照してください。 | |
|
| SelfSubjectRulesReviewSpec は、SelfSubjectRulesReview の仕様を定義します。 |
|
| SubjectRulesReviewStatus には、ルールチェックの結果が含まれています。このチェックは、サーバーが設定されている Authorizer のセットと、評価中に発生したエラーによっては不完全になる可能性があります。認可ルールは付加的なものであるため、ルールがリストに表示されている場合は、そのリストが不完全であっても、サブジェクトがその許可を持っていると見なすのが安全です。 |
9.4.1.1. .spec
- 説明
- SelfSubjectRulesReviewSpec は、SelfSubjectRulesReview の仕様を定義します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| ルールを評価するための namespace。必須。 |
9.4.1.2. .status
- 説明
- SubjectRulesReviewStatus には、ルールチェックの結果が含まれています。このチェックは、サーバーが設定されている Authorizer のセットと、評価中に発生したエラーによっては不完全になる可能性があります。認可ルールは付加的なものであるため、ルールがリストに表示されている場合は、そのリストが不完全であっても、サブジェクトがその許可を持っていると見なすのが安全です。
- 型
-
object
- 必須
-
resourceRules
-
nonResourceRules
-
incomplete
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| evaluationError は、ルールと組み合わせて表示される場合があります。これは、ルール評価をサポートしていない Authorizer など、ルール評価中にエラーが発生したこと、および ResourceRules や NonResourceRules が不完全である可能性があることを示しています。 |
|
| この呼び出しによって返されるルールが不完全な場合、Incomplete は true です。これは、外部の Authorizer などの Authorizer がルールの評価をサポートしていない場合に最もよく発生します。 |
|
| nonResourceRules は、サブジェクトが非リソースに対して実行できるアクションのリストです。リストの順序は重要ではなく、重複が含まれている可能性があり、不完全である可能性があります。 |
|
| nonResourceRule は、非リソースのルールを説明する情報を保持します。 |
|
| resourceRules は、サブジェクトがリソースに対して実行できるアクションのリストです。リストの順序は重要ではなく、重複が含まれている可能性があり、不完全である可能性があります。 |
|
| resourceRule は、サブジェクトがリソースに対して実行できるアクションのリストです。リストの順序は重要ではなく、重複が含まれている可能性があり、不完全である可能性があります。 |
9.4.1.3. .status.nonResourceRules
- 説明
- nonResourceRules は、サブジェクトが非リソースに対して実行できるアクションのリストです。リストの順序は重要ではなく、重複が含まれている可能性があり、不完全である可能性があります。
- 型
-
array
9.4.1.4. .status.nonResourceRules[]
- 説明
- nonResourceRule は、非リソースのルールを説明する情報を保持します。
- 型
-
object
- 必須
-
verbs
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| nonResourceURLs は、ユーザーがアクセスできる必要のある部分的な URL のセットです。s は許可されますが、パスの完全な最終ステップとしてのみ許可されます。"" はすべてを意味します。 |
|
| verbs は、get、post、put、delete、patch、head、options などの kubernetes の非リソース API 動詞のリストです。"*" はすべてを意味します。 |
9.4.1.5. .status.resourceRules
- 説明
- resourceRules は、サブジェクトがリソースに対して実行できるアクションのリストです。リストの順序は重要ではなく、重複が含まれている可能性があり、不完全である可能性があります。
- 型
-
array
9.4.1.6. .status.resourceRules[]
- 説明
- resourceRule は、サブジェクトがリソースに対して実行できるアクションのリストです。リストの順序は重要ではなく、重複が含まれている可能性があり、不完全である可能性があります。
- 型
-
object
- 必須
-
verbs
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiGroups は、リソースを含む APIGroup の名前です。複数の API グループが指定されている場合は、任意の API グループ内の列挙されたリソースの 1 つに対して要求されたすべてのアクションが許可されます。"*" はすべてを意味します。 |
|
| resourceNames は、ルールが適用される名前のオプションのホワイトリストです。空のセットは、すべてが許可されていることを意味します。"*" はすべてを意味します。 |
|
| resources は、このルールが適用されるリソースのリストです。"" は、指定された apiGroups 内のすべてを意味します。"/foo" は、指定された apiGroups 内のすべてのリソースのサブリソース 'foo' を表します。 |
|
| verbs は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞のリストです。"*" はすべてを意味します。 |
9.4.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/authorization.k8s.io/v1/selfsubjectrulesreviews
-
POST
: SelfSubjectRulesReview を作成する
-
9.4.2.1. /apis/authorization.k8s.io/v1/selfsubjectrulesreviews
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- SelfSubjectRulesReview を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
9.5. SubjectAccessReview [authorization.k8s.io/v1]
- 説明
- SubjectAccessReview は、ユーザーまたはグループがアクションを実行できるかどうかをチェックします。
- 型
-
object
- 必須
-
spec
-
9.5.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準のリストメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| SubjectAccessReviewSpec は、アクセス要求の説明です。ResourceAuthorizationAttributes と NonResourceAuthorizationAttributes のいずれかを設定する必要があります。 |
|
| SubjectAccessReviewStatus |
9.5.1.1. .spec
- 説明
- SubjectAccessReviewSpec は、アクセス要求の説明です。ResourceAuthorizationAttributes と NonResourceAuthorizationAttributes のいずれかを設定する必要があります。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| extra は、オーセンティケーターの user.Info.GetExtra() メソッドに対応します。これは Authorizer に入力されるため、ここで反映する必要があります。 |
|
| |
|
| groups は、テストしているグループです。 |
|
| nonResourceAttributes には、Authorizer インターフェイスへの非リソース要求に使用できる許可属性が含まれています。 |
|
| resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています。 |
|
| 要求しているユーザーに関する UID 情報。 |
|
| user は、テストしているユーザーです。"user" を指定し、"groups" を指定しない場合は、「そのユーザーがどのグループにも所属していなかったらどうなるか」という意味になります。 |
9.5.1.2. .spec.extra
- 説明
- extra は、オーセンティケーターの user.Info.GetExtra() メソッドに対応します。これは Authorizer に入力されるため、ここで反映する必要があります。
- 型
-
object
9.5.1.3. .spec.nonResourceAttributes
- 説明
- nonResourceAttributes には、Authorizer インターフェイスへの非リソース要求に使用できる許可属性が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| path はリクエストの URL パスです。 |
|
| verb は標準の HTTP 動詞です。 |
9.5.1.4. .spec.resourceAttributes
- 説明
- resourceAttributes には、Authorizer インターフェイスへのリソース要求に使用できる許可属性が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| グループは、リソースの API グループです。"*" はすべてを意味します。 |
|
| name は、"取得" のために要求されているリソース、または "削除" のために削除されているリソースの名前です。"" (空) はすべてを意味します。 |
|
| namespace は、要求されているアクションの namespace です。現在、namespace なしとすべての namespace の区別はありません。""(空) は LocalSubjectAccessReviews のデフォルトです。""(空) はクラスタースコープのリソースでは空です。""(空) は SubjectAccessReview または SelfSubjectAccessReview からの namespace スコープのリソースの "すべて" を意味します。 |
|
| resource は、既存のリソースタイプの 1 つです。"*" はすべてを意味します。 |
|
| subresource は、既存のリソースタイプの 1 つです。"" は何もないことを意味します。 |
|
| verb は、get、list、watch、create、update、delete、proxy などの kubernetes リソース API 動詞です。"*" はすべてを意味します。 |
|
| バージョンは、リソースの API バージョンです。"*" はすべてを意味します。 |
9.5.1.5. .status
- 説明
- SubjectAccessReviewStatus
- 型
-
object
- 必須
-
allowed
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| allowed は必須です。アクションを許可する場合は true、許可しない場合は false です。 |
|
| denied はオプションです。アクションを拒否する場合は true、許可しない場合は false です。allowed と denied の両方が false の場合は、Authorizer がアクションを許可するかどうかについて意見を持っていません。allowed が true の場合は、denied が true ではない可能性があります。 |
|
| evaluationError は、認可チェック中にエラーが発生したことを示します。エラーが発生し、それにもかかわらず認可ステータスを判別し続けることはできます。たとえば、RBAC にロールがない可能性がありますが、十分なロールがまだ存在しており、要求の理由に拘束されています。 |
|
| reason はオプションです。リクエストが許可または拒否された理由を示します。 |
9.5.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/authorization.k8s.io/v1/subjectaccessreviews
-
POST
: SubjectAccessReview を作成する
-
9.5.2.1. /apis/authorization.k8s.io/v1/subjectaccessreviews
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- SubjectAccessReview を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
第10章 自動スケーリング API
10.1. 自動スケーリング API
10.1.1. スケール [autoscaling/v1]
- 説明
- Scale は、リソースのスケーリング要求を表します。
- 型
-
object
10.1.2. HorizontalPodAutoscaler [autoscaling/v2]
- 説明
- HorizontalPodAutoscaler は、Horizontal Pod Autoscaler の設定であり、指定されたメトリクスに基づいて scale サブリソースを実装するリソースのレプリカ数を自動的に管理します。
- 型
-
object
10.2. HorizontalPodAutoscaler [autoscaling/v2]
- 説明
- HorizontalPodAutoscaler は、Horizontal Pod Autoscaler の設定であり、指定されたメトリクスに基づいて scale サブリソースを実装するリソースのレプリカ数を自動的に管理します。
- 型
-
object
10.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 を参照してください。 |
| metadata は標準のオブジェクトメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| HorizontalPodAutoscalerSpec は、HorizontalPodAutoscaler の必要な機能を記述します。 |
|
| HorizontalPodAutoscalerStatus は、Horizontal Pod Autoscaler の現在のステータスを記述します。 |
10.2.1.1. .spec
- 説明
- HorizontalPodAutoscalerSpec は、HorizontalPodAutoscaler の必要な機能を記述します。
- 型
-
object
- 必須
-
scaleTargetRef
-
maxReplicas
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| HorizontalPodAutoscalerBehavior は、上方向と下方向の両方のターゲットのスケーリング動作を設定します (それぞれ、scaleUp フィールドと scaleDown フィールド)。 |
|
| maxReplicas は、Autoscaler がスケールアップできるレプリカの数の上限です。minReplicas の数より少なくすることはできません。 |
|
| metrics には、必要なレプリカ数を計算するために使用する仕様が含まれています (すべてのメトリックでの最大レプリカ数が使用されます)。必要なレプリカ数は、ターゲット値と現在の値の比率に現在の Pod 数を乗算して計算されます。したがって、Pod 数が増加すると、使用されるメトリックを減らす必要があります。またその逆も同様です。各タイプのメトリックがどのように応答する必要があるかは、個々のメトリックソースタイプを参照してください。設定されていない場合、デフォルトのメトリックは平均 CPU 使用率 80% に設定されます。 |
|
|
MetricSpec は、単一のメトリックに基づいてスケーリングする方法を指定します (一度に設定できるのは、 |
|
| minReplicas は、オートスケーラーがスケールダウンできるレプリカの数の下限です。デフォルトは 1 Pod です。アルファ機能ゲート HPAScaleToZero が有効で、少なくとも 1 つのオブジェクトまたは外部メトリックが設定されている場合、minReplicas は 0 になります。スケーリングは、少なくとも 1 つのメトリック値が使用可能である限りアクティブです。 |
|
| CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。 |
10.2.1.2. .spec.behavior
- 説明
- HorizontalPodAutoscalerBehavior は、上方向と下方向の両方のターゲットのスケーリング動作を設定します (それぞれ、scaleUp フィールドと scaleDown フィールド)。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。 |
|
| HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。 |
10.2.1.3. .spec.behavior.scaleDown
- 説明
- HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| policies は、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しないと、HPAScalingRules は無効として破棄されます。 |
|
| HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。 |
|
| selectPolicy は、どのポリシーを使用するかを指定するために使用されます。設定されていないと、デフォルト値の Max が使用されます。 |
|
| stabilizationWindowSeconds は、スケールアップまたはスケールダウン中に過去の推奨事項を考慮する必要がある時間 (秒) です。StabilizationWindowSeconds は、0 以上 3600 (1 時間) 以下である必要があります。設定されていないと、デフォルト値を使用します。- スケールアップの場合: 0 (固定化なし)。- スケールダウンの場合: 300 (固定化ウィンドウの長さは 300 秒です)。 |
10.2.1.4. .spec.behavior.scaleDown.policies
- 説明
- policies は、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しないと、HPAScalingRules は無効として破棄されます。
- 型
-
array
10.2.1.5. .spec.behavior.scaleDown.policies[]
- 説明
- HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。
- 型
-
object
- 必須
-
type
-
value
-
periodSeconds
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| periodSeconds は、ポリシーが適用される時間枠を指定します。periodSeconds は、0 より大きく、1800 (30 分) 以下にする必要があります。 |
|
| type はスケーリングポリシーを指定するために使用されます。 |
|
| value には、ポリシーによって許可されている変更量が含まれます。ゼロより大きくなければなりません |
10.2.1.6. .spec.behavior.scaleUp
- 説明
- HPAScalingRules は、一方向のスケーリング動作を設定します。これらのルールは、HPA のメトリクスから DesiredReplicas を計算した後に適用されます。スケーリングポリシーを指定することで、スケーリング速度を制限できます。安定化ウィンドウを指定してフラッピングを防ぐことができ、レプリカの数が即座に設定されるのではなく、固定化ウィンドウから最も安全な値が選択されます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| policies は、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しないと、HPAScalingRules は無効として破棄されます。 |
|
| HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。 |
|
| selectPolicy は、どのポリシーを使用するかを指定するために使用されます。設定されていないと、デフォルト値の Max が使用されます。 |
|
| stabilizationWindowSeconds は、スケールアップまたはスケールダウン中に過去の推奨事項を考慮する必要がある時間 (秒) です。StabilizationWindowSeconds は、0 以上 3600 (1 時間) 以下である必要があります。設定されていないと、デフォルト値を使用します。- スケールアップの場合: 0 (固定化なし)。- スケールダウンの場合: 300 (固定化ウィンドウの長さは 300 秒です)。 |
10.2.1.7. .spec.behavior.scaleUp.policies
- 説明
- policies は、スケーリング中に使用できる潜在的なスケーリングポリシーのリストです。少なくとも 1 つのポリシーを指定する必要があります。指定しないと、HPAScalingRules は無効として破棄されます。
- 型
-
array
10.2.1.8. .spec.behavior.scaleUp.policies[]
- 説明
- HPAScalingPolicy は、指定された過去の期間にわたって合致する必要がある単一のポリシーです。
- 型
-
object
- 必須
-
type
-
value
-
periodSeconds
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| periodSeconds は、ポリシーが適用される時間枠を指定します。periodSeconds は、0 より大きく、1800 (30 分) 以下にする必要があります。 |
|
| type はスケーリングポリシーを指定するために使用されます。 |
|
| value には、ポリシーによって許可されている変更量が含まれます。ゼロより大きくなければなりません |
10.2.1.9. .spec.metrics
- 説明
- metrics には、必要なレプリカ数を計算するために使用する仕様が含まれています (すべてのメトリックでの最大レプリカ数が使用されます)。必要なレプリカ数は、ターゲット値と現在の値の比率に現在の Pod 数を乗算して計算されます。したがって、Pod 数が増加すると、使用されるメトリックを減らす必要があります。またその逆も同様です。各タイプのメトリックがどのように応答する必要があるかは、個々のメトリックソースタイプを参照してください。設定されていない場合、デフォルトのメトリックは平均 CPU 使用率 80% に設定されます。
- 型
-
array
10.2.1.10. .spec.metrics[]
- 説明
-
MetricSpec は、単一のメトリックに基づいてスケーリングする方法を指定します (一度に設定できるのは、
type
と他の 1 つの一致フィールドのみです)。 - 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| ContainerResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの "target" タイプのみを設定する必要があります。 |
|
| ExternalMetricSource は、Kubernetes オブジェクトに関連付けられていないメトリック (クラウドメッセージングサービスのキューの長さ、クラスターの外部で実行されているロードバランサーからの QPS など) に基づいてスケールする方法を示します。 |
|
| ObjectMetricSource は、kubernetes オブジェクトを記述するメトリック (例: Ingress オブジェクトの 1 秒あたりのヒット数) をスケールする方法を示します。 |
|
| PodsMetricSource は、現在のスケールターゲットで各 Pod を記述するメトリック (例: 1 秒あたりのトランザクション処理数) に基づいてスケールする方法を示します。値はターゲット値と比較される前に平均化されます。 |
|
| ResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの "target" タイプのみを設定する必要があります。 |
|
| type はメトリックソースのタイプです。これは、"ContainerResource"、"External"、"Object"、"Pod"、または "Resource" のいずれかであり、それぞれがオブジェクト内の一致するフィールドに対応します。注記: "ContainerResource" タイプは、フィーチャーゲート HPAContainerMetrics が有効になっていると使用できます。 |
10.2.1.11. .spec.metrics[].containerResource
- 説明
- ContainerResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの "target" タイプのみを設定する必要があります。
- 型
-
object
- 必須
-
name
-
target
-
container
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| container は、スケーリングターゲットの Pod にあるコンテナーの名前です。 |
|
| name は、対象のリソースの名前です。 |
|
| MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。 |
10.2.1.12. .spec.metrics[].containerResource.target
- 説明
- MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です |
| averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。 | |
|
| type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。 |
| value は、メトリックの目標値 (数量として) です。 |
10.2.1.13. .spec.metrics[].external
- 説明
- ExternalMetricSource は、Kubernetes オブジェクトに関連付けられていないメトリック (クラウドメッセージングサービスのキューの長さ、クラスターの外部で実行されているロードバランサーからの QPS など) に基づいてスケールする方法を示します。
- 型
-
object
- 必須
-
metric
-
target
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。 |
|
| MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。 |
10.2.1.14. .spec.metrics[].external.metric
- 説明
- MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、指定されたメトリクスの名前です。 |
| selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。 |
10.2.1.15. .spec.metrics[].external.target
- 説明
- MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です |
| averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。 | |
|
| type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。 |
| value は、メトリックの目標値 (数量として) です。 |
10.2.1.16. .spec.metrics[].object
- 説明
- ObjectMetricSource は、kubernetes オブジェクトを記述するメトリック (例: Ingress オブジェクトの 1 秒あたりのヒット数) をスケールする方法を示します。
- 型
-
object
- 必須
-
describedObject
-
target
-
metric
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。 |
|
| MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。 |
|
| MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。 |
10.2.1.17. .spec.metrics[].object.describedObject
- 説明
- CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion は参照先の API バージョンです。 |
|
| kind は指示対象の種類です。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| name は指示対象の名前です。詳細は、https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names を参照してください。 |
10.2.1.18. .spec.metrics[].object.metric
- 説明
- MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、指定されたメトリクスの名前です。 |
| selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。 |
10.2.1.19. .spec.metrics[].object.target
- 説明
- MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です |
| averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。 | |
|
| type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。 |
| value は、メトリックの目標値 (数量として) です。 |
10.2.1.20. .spec.metrics[].pods
- 説明
- PodsMetricSource は、現在のスケールターゲットで各 Pod を記述するメトリック (例: 1 秒あたりのトランザクション処理数) に基づいてスケールする方法を示します。値はターゲット値と比較される前に平均化されます。
- 型
-
object
- 必須
-
metric
-
target
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。 |
|
| MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。 |
10.2.1.21. .spec.metrics[].pods.metric
- 説明
- MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、指定されたメトリクスの名前です。 |
| selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。 |
10.2.1.22. .spec.metrics[].pods.target
- 説明
- MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です |
| averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。 | |
|
| type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。 |
| value は、メトリックの目標値 (数量として) です。 |
10.2.1.23. .spec.metrics[].resource
- 説明
- ResourceMetricSource は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックに基づいてスケーリングする方法を示します。各 Pod は、現在のスケールターゲット (CPU やメモリーなど) で記述します。値はターゲットと比較される前に平均化されます。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。1 つの "target" タイプのみを設定する必要があります。
- 型
-
object
- 必須
-
name
-
target
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、対象のリソースの名前です。 |
|
| MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。 |
10.2.1.24. .spec.metrics[].resource.target
- 説明
- MetricTarget は、特定のメトリックのターゲット値、平均値、または平均使用率を定義します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| averageUtilization は、関連する全 Pod のリソースメトリクスの平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。現在、Resource metric source type に対してのみ有効です |
| averageValue は、関連するすべての Pod にわたるメトリックの平均ターゲット値 (数量) です。 | |
|
| type は、メトリックタイプが Utilization、Value、または AverageValue のいずれであるかを表します。 |
| value は、メトリックの目標値 (数量として) です。 |
10.2.1.25. .spec.scaleTargetRef
- 説明
- CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion は参照先の API バージョンです。 |
|
| kind は指示対象の種類です。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| name は指示対象の名前です。詳細は、https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names を参照してください。 |
10.2.1.26. .status
- 説明
- HorizontalPodAutoscalerStatus は、Horizontal Pod Autoscaler の現在のステータスを記述します。
- 型
-
object
- 必須
-
desiredReplicas
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| conditions は、このオートスケーラーがターゲットをスケーリングするために必要な一連の条件であり、それらの条件が満たされているかどうかを示します。 |
|
| HorizontalPodAutoscalerCondition は、特定の時点での HorizontalPodAutoscaler の状態を記述します。 |
|
| currentMetrics は、このオートスケーラーに使用されるメトリクスの最後の読み取り状態です。 |
|
| MetricStatus は、単一メトリックの最後に読み取られた状態を表します。 |
|
| currentReplicas は、オートスケーラーが管理する Pod のレプリカ数で、オートスケーラーが最後に確認した数値です。 |
|
| desiredReplicas は、オートスケーラーが管理する Pod の任意のレプリカ数で、オートスケーラーが最後に計算した数値です。 |
| lastScaleTime は、HorizontalPodAutoscaler が Pod の数を最後にスケーリングした時間であり、オートスケーラーが Pod の数を変更する頻度を制御するために使用されます。 | |
|
| observedGeneration は、このオートスケーラーによって確認された最新の世代です。 |
10.2.1.27. .status.conditions
- 説明
- conditions は、このオートスケーラーがターゲットをスケーリングするために必要な一連の条件であり、それらの条件が満たされているかどうかを示します。
- 型
-
array
10.2.1.28. .status.conditions[]
- 説明
- HorizontalPodAutoscalerCondition は、特定の時点での HorizontalPodAutoscaler の状態を記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| lastTransitionTime は、別の状態に最後に遷移した時間です。 | |
|
| message は、遷移の詳細を含む、人間が判読できる説明です。 |
|
| reason は、条件の最後の遷移の理由です。 |
|
| status は条件のステータス (True、False、Unknown) です。 |
|
| type は現在の状態を表します |
10.2.1.29. .status.currentMetrics
- 説明
- currentMetrics は、このオートスケーラーに使用されるメトリクスの最後の読み取り状態です。
- 型
-
array
10.2.1.30. .status.currentMetrics[]
- 説明
- MetricStatus は、単一メトリックの最後に読み取られた状態を表します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| ContainerResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックの現在値を示し、現在のスケールターゲット (CPU やメモリーなど) で、各 Pod に含まれる単一のコンテナーを記述します。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。 |
|
| ExternalMetricStatus は、Kubernetes オブジェクトに関連付けられていないグローバルメトリクスの現在の値を示します。 |
|
| ObjectMetricStatus は、kubernetes オブジェクトを説明するメトリックの現在の値 (例: Ingress オブジェクトの 1 秒あたりのヒット数) を示します。 |
|
| PodsMetricStatus は、現在のスケールターゲット内の各 Pod を説明するメトリックの現在の値 (例: 1 秒あたりのトランザクション処理数) を示します。 |
|
| ResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes に認識されているリソースメトリックの現在の値を示し、現在のスケールターゲット (CPU やメモリーなど) で各 Pod を記述します。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。 |
|
| type はメトリックソースのタイプです。これは "ContainerResource"、"External"、"Object"、"Pod"、または "Resource" のいずれかであり、それぞれがオブジェクト内の一致するフィールドに対応します。注記: "ContainerResource" タイプは、フィーチャーゲート HPAContainerMetrics が有効になっていると使用できます。 |
10.2.1.31. .status.currentMetrics[].containerResource
- 説明
- ContainerResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes で認識されているリソースメトリックの現在値を示し、現在のスケールターゲット (CPU やメモリーなど) で、各 Pod に含まれる単一のコンテナーを記述します。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。
- 型
-
object
- 必須
-
name
-
current
-
container
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| container は、スケーリングターゲットの Pod にあるコンテナーの名前です。 |
|
| MetricValueStatus は、メトリクスの現在の値を保持します。 |
|
| name は、対象のリソースの名前です。 |
10.2.1.32. .status.currentMetrics[].containerResource.current
- 説明
- MetricValueStatus は、メトリクスの現在の値を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。 |
| averageValue は、関連するすべての Pod にわたるメトリックの現在における平均値 (数量) です。 | |
| value は、メトリックの現在における平均値 (数量) です。 |
10.2.1.33. .status.currentMetrics[].external
- 説明
- ExternalMetricStatus は、Kubernetes オブジェクトに関連付けられていないグローバルメトリクスの現在の値を示します。
- 型
-
object
- 必須
-
metric
-
current
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| MetricValueStatus は、メトリクスの現在の値を保持します。 |
|
| MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。 |
10.2.1.34. .status.currentMetrics[].external.current
- 説明
- MetricValueStatus は、メトリクスの現在の値を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。 |
| averageValue は、関連するすべての Pod にわたるメトリックの現在における平均値 (数量) です。 | |
| value は、メトリックの現在における平均値 (数量) です。 |
10.2.1.35. .status.currentMetrics[].external.metric
- 説明
- MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、指定されたメトリクスの名前です。 |
| selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。 |
10.2.1.36. .status.currentMetrics[].object
- 説明
- ObjectMetricStatus は、kubernetes オブジェクトを説明するメトリックの現在の値 (例: Ingress オブジェクトの 1 秒あたりのヒット数) を示します。
- 型
-
object
- 必須
-
metric
-
current
-
describedObject
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| MetricValueStatus は、メトリクスの現在の値を保持します。 |
|
| CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。 |
|
| MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。 |
10.2.1.37. .status.currentMetrics[].object.current
- 説明
- MetricValueStatus は、メトリクスの現在の値を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。 |
| averageValue は、関連するすべての Pod にわたるメトリックの現在における平均値 (数量) です。 | |
| value は、メトリックの現在における平均値 (数量) です。 |
10.2.1.38. .status.currentMetrics[].object.describedObject
- 説明
- CrossVersionObjectReference には、参照されたリソースを識別できるようにするための十分な情報が含まれています。
- 型
-
object
- 必須
-
kind
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion は参照先の API バージョンです。 |
|
| kind は指示対象の種類です。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| name は指示対象の名前です。詳細は、https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names を参照してください。 |
10.2.1.39. .status.currentMetrics[].object.metric
- 説明
- MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、指定されたメトリクスの名前です。 |
| selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。 |
10.2.1.40. .status.currentMetrics[].pods
- 説明
- PodsMetricStatus は、現在のスケールターゲット内の各 Pod を説明するメトリックの現在の値 (例: 1 秒あたりのトランザクション処理数) を示します。
- 型
-
object
- 必須
-
metric
-
current
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| MetricValueStatus は、メトリクスの現在の値を保持します。 |
|
| MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。 |
10.2.1.41. .status.currentMetrics[].pods.current
- 説明
- MetricValueStatus は、メトリクスの現在の値を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。 |
| averageValue は、関連するすべての Pod にわたるメトリックの現在における平均値 (数量) です。 | |
| value は、メトリックの現在における平均値 (数量) です。 |
10.2.1.42. .status.currentMetrics[].pods.metric
- 説明
- MetricIdentifier は、メトリクスの名前およびオプションでセレクターを定義します。
- 型
-
object
- 必須
-
name
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| name は、指定されたメトリクスの名前です。 |
| selector は、指定されたメトリックの標準 Kubernetes ラベルセレクターの文字列エンコード形式です。設定すると、追加パラメーターとしてメトリックサーバーに渡され、より具体的にメトリックのスコープを設定します。設定を解除すると、metricName のみがメトリクスの収集に使用されます。 |
10.2.1.43. .status.currentMetrics[].resource
- 説明
- ResourceMetricStatus は、リクエストと制限で指定されているように、Kubernetes に認識されているリソースメトリックの現在の値を示し、現在のスケールターゲット (CPU やメモリーなど) で各 Pod を記述します。このようなメトリックは Kubernetes に組み込まれており、"Pod" ソースを使用する通常の Pod ごとのメトリックに利用可能なオプションに加えて、特別なスケーリングオプションがあります。
- 型
-
object
- 必須
-
name
-
current
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| MetricValueStatus は、メトリクスの現在の値を保持します。 |
|
| name は、対象のリソースの名前です。 |
10.2.1.44. .status.currentMetrics[].resource.current
- 説明
- MetricValueStatus は、メトリクスの現在の値を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| curentAverageUtilization は、関連する全 Pod のリソースメトリクスの現在における平均値であり、Pod のリソースの要求値に占めるパーセンテージとして表されます。 |
| averageValue は、関連するすべての Pod にわたるメトリックの現在における平均値 (数量) です。 | |
| value は、メトリックの現在における平均値 (数量) です。 |
10.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/autoscaling/v2/horizontalpodautoscalers
-
GET
: 種類 HorizontalPodAutoscaler のオブジェクトをリストまたは監視します。
-
/apis/autoscaling/v2/watch/horizontalpodautoscalers
-
GET
: HorizontalPodAutoscaler のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
-
DELETE
: HorizontalPodAutoscaler のコレクションを削除します。 -
GET
: 種類 HorizontalPodAutoscaler のオブジェクトをリストまたは監視します。 -
POST
: HorizontalPodAutoscaler を作成します。
-
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
-
GET
: HorizontalPodAutoscaler のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
DELETE
: HorizontalPodAutoscaler を削除します。 -
GET
: 指定された HorizontalPodAutoscaler を読み取ります。 -
PATCH
: 指定された HorizontalPodAutoscaler を部分的に更新します。 -
PUT
: 指定された HorizontalPodAutoscaler を置き換えます。
-
/apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
-
GET
:HorizontalPodAutoscaler の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
-
GET
: 指定した HorizontalPodAutoscaler のステータスを読み取ります。 -
PATCH
: 指定された HorizontalPodAutoscaler のステータスを部分的に更新します。 -
PUT
: 指定した HorizontalPodAutoscaler のステータスを置き換えます。
-
10.2.2.1. /apis/autoscaling/v2/horizontalpodautoscalers
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類 HorizontalPodAutoscaler のオブジェクトをリストまたは監視します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
10.2.2.2. /apis/autoscaling/v2/watch/horizontalpodautoscalers
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 個々の変更を HorizontalPodAutoscaler のリストに監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
10.2.2.3. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- HorizontalPodAutoscaler のコレクションを削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示または監視する HorizontalPodAutoscaler
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- HorizontalPodAutoscaler を作成します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
10.2.2.4. /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 個々の変更を HorizontalPodAutoscaler のリストに監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
10.2.2.5. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| HorizontalPodAutoscaler の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- HorizontalPodAutoscaler を削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定した HorizontalPodAutoscaler を読み取ります。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定した HorizontalPodAutoscaler を部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定した HorizontalPodAutoscaler を置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
10.2.2.6. /apis/autoscaling/v2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| HorizontalPodAutoscaler の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類が HorizontalPodAutoscaler のオブジェクトに変更されるのを監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
10.2.2.7. /apis/autoscaling/v2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| HorizontalPodAutoscaler の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定した HorizontalPodAutoscaler のステータスを読み取ります。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定した HorizontalPodAutoscaler のステータスを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定した HorizontalPodAutoscaler のステータスを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
10.3. Scale [autoscaling/v1]
- 説明
- Scale は、リソースのスケーリング要求を表します。
- 型
-
object
10.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 を参照してください。 | |
|
| ScaleSpec は、スケールサブリソースの属性を記述します。 |
|
| ScaleStatus は、スケールサブリソースの現在のステータスを表します。 |
10.3.1.1. .spec
- 説明
- ScaleSpec は、スケールサブリソースの属性を記述します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| replicas は、スケーリングされたオブジェクトに必要なインスタンスの数です。 |
10.3.1.2. .status
- 説明
- ScaleStatus は、スケールサブリソースの現在のステータスを表します。
- 型
-
object
- 必須
-
replicas
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| replicas は、スケーリングされたオブジェクトで確認されたインスタンスの実際の数です。 |
|
| selector は、replicas 数と一致する必要がある Pod に対するラベルクエリーです。これはラベルセレクターと同じですが、クライアントによるイントロスペクションを回避するために文字列形式になっています。文字列は、query-param 構文と同じ形式になります。ラベルセレクターの詳細は、https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ を参照してください。 |
10.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
-
GET
: 指定したデプロイメントのスケールを読み取ります。 -
PATCH
: 指定したデプロイメントのスケールを部分的に更新します。 -
PUT
: 指定したデプロイメントのスケールを置き換えます。
-
/apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
-
GET
: 指定した ReplicaSet のスケールを読み取ります。 -
PATCH
: 指定した ReplicaSet のスケールを部分的に更新します。 -
PUT
: 指定した ReplicaSet のスケールを置き換えます。
-
/apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
-
GET
: 指定した StatefulSet のスケールを読み取ります。 -
PATCH
: 指定した StatefulSet のスケールを部分的に更新します。 -
PUT
: 指定した StatefulSet のスケールを置き換えます。
-
/api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
-
GET
: 指定した ReplicationController のスケールを読み取ります。 -
PATCH
: 指定した ReplicationController のスケールを部分的に更新します。 -
PUT
: 指定した ReplicationController のスケールを置き換えます。
-
10.3.2.1. /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
パラメーター | 型 | 説明 |
---|---|---|
|
| スケールの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| '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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
10.3.2.2. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
パラメーター | 型 | 説明 |
---|---|---|
|
| スケールの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定した ReplicaSet のスケールを読み取ります。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定した ReplicaSet のスケールを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定した ReplicaSet のスケールを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
10.3.2.3. /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
パラメーター | 型 | 説明 |
---|---|---|
|
| スケールの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定した StatefulSet のスケールを読み取ります。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定した StatefulSet のスケールを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定した StatefulSet のスケールを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
10.3.2.4. /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
パラメーター | 型 | 説明 |
---|---|---|
|
| スケールの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定した ReplicationController のスケールを読み取ります。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定した ReplicationController のスケールを部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定した ReplicationController のスケールを置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第11章 バッチ API
11.1. バッチ API
11.1.1. CronJob [batch/v1]
- 説明
- CronJob は、単一の cron ジョブの設定を表します。
- 型
-
object
11.1.2. Job [batch/v1]
- 説明
- Job は、単一の Job の設定を表します。
- 型
-
object
11.2. CronJob [batch/v1]
- 説明
- CronJob は、単一の cron ジョブの設定を表します。
- 型
-
object
11.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 を参照してください。 | |
|
| CronJobSpec は、ジョブの実行がどのようになり、実際にいつ実行されるかを記述します。 |
|
| CronJobStatus は、cron ジョブの現在の状態を表します。 |
11.2.1.1. .spec
- 説明
- CronJobSpec は、ジョブの実行がどのようになり、実際にいつ実行されるかを記述します。
- 型
-
object
- 必須
-
スケジュール
-
jobTemplate
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| ジョブの同時実行を処理する方法を指定します。有効な値は以下のとおりです。 - "Allow" (デフォルト):CronJobs の同時実行を許可します。- "Forbid": 同時実行を禁止し、前の実行がまだ終了していない場合は次の実行をスキップします。- "Replace": 現在実行中のジョブをキャンセルし、新しいジョブに置き換えます。
有効な列挙値: |
|
| 保持する失敗した終了ジョブの数。値は負の値ではない整数にする必要があります。デフォルトは 1 です。 |
|
| JobTemplateSpec は、テンプレートから作成されたときにジョブが持つべきデータを記述します |
|
| Cron 形式のスケジュールは、https://en.wikipedia.org/wiki/Cron を参照してください。 |
|
| ジョブを開始するためのオプションの期限 (秒単位)(何らかの理由によりスケジュールされた時間が経過する場合)。ジョブの実行が行われない場合、ジョブの失敗としてカウントされます。 |
|
| 保持する成功した終了済みジョブの数。値は負の値ではない整数にする必要があります。デフォルトは 3 です。 |
|
| このフラグは、後続の実行を一時停止するようにコントローラーに指示します。すでに開始されている実行には適用されません。デフォルトは false です。 |
|
| 指定されたスケジュールのタイムゾーン名は、https://en.wikipedia.org/wiki/List_of_tz_database_time_zones を参照してください。指定しない場合、デフォルトで kube-controller-manager プロセスのタイムゾーンが使用されます。有効なタイムゾーン名とタイムゾーンオフセットのセットは、CronJob の検証中および実行時にコントローラーマネージャーによって、システム全体のタイムゾーンデータベースから読み込まれます。システム全体のタイムゾーンデータベースが見つからない場合は、代わりにバンドル化されたバージョンのデータベースが使用されます。CronJob の有効期間中またはホスト設定の変更によってタイムゾーン名が無効になると、コントローラーは新しいジョブの作成を停止し、理由が UnknownTimeZone のシステムイベントを作成します。詳細は、https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones を参照してください。 |
11.2.1.2. .spec.jobTemplate
- 説明
- JobTemplateSpec は、テンプレートから作成されたときにジョブが持つべきデータを記述します
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| このテンプレートから作成されたジョブの標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| JobSpec は、ジョブの実行がどのようになるかを記述します。 |
11.2.1.3. .spec.jobTemplate.spec
- 説明
- JobSpec は、ジョブの実行がどのようになるかを記述します。
- 型
-
object
- 必須
-
template
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| システムがジョブを終了しようとする前に、ジョブが継続的にアクティブになる可能性がある startTime を基準とした秒単位の期間を指定します。値は正の整数でなければなりません。ジョブが (作成時または更新中に) 一時停止になった場合、このタイマーは事実上停止となり、ジョブが再開したときにリセットされます。 |
|
| このジョブを失敗とマークするまでの再試行回数を指定します。デフォルトは 6 です。 |
|
|
completionMode は、Pod の完了を追跡する方法を指定します。
今後、さらに多くの完了モードを追加できます。ジョブコントローラーが認識できないモードを確認した場合、コントローラーはジョブの更新をスキップします。
可能な列挙値: |
|
| ジョブを実行するために正常に終了した Pod の希望数を指定します。null に設定すると、任意の Pod の成功がすべての Pod の成功を示し、並列処理に正の値を設定できるようになります。1 に設定すると、並列処理が 1 に制限され、その Pod の成功がジョブの成功を示します。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
manualSelector は、Pod ラベルと Pod セレクターの生成を制御します。何をしているのかわからない場合は、 |
|
| ジョブが任意の時点で実行する必要のある Pod の最大数を指定します。定常状態で実行している Pod の実際の数は、((.spec.completions - .status.successful) < .spec.parallelism) の場合、つまり、実行する必要のある作業が最大並列処理より少ない場合は、この数より少なくなります。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
| PodFailurePolicy は、失敗した Pod が backoffLimit にどのように影響するかを説明します。 |
| Pod 数と一致する必要がある Pod に対するラベルクエリー。通常、システムはこのフィールドを設定します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
| suspend は、Job コントローラーが Pod を作成するかどうかを指定します。suspend を true に設定して Job を作成すると、ジョブコントローラーは Pod を作成しません。作成後に Job が一時停止した場合 (つまり、フラグが false から true になる場合)、Job コントローラーはこの Job に関連付けられているすべてのアクティブな Pod を削除します。ユーザーは、これを適切に処理するようにワークロードを設計する必要があります。ジョブを一時停止すると、ジョブの StartTime フィールドがリセットされ、ActiveDeadlineSeconds タイマーも効果的にリセットされます。デフォルトは false です。 |
| ジョブの実行時に作成される Pod を説明します。使用できる template.spec.restartPolicy の値は "Never" または "OnFailure" のみです。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | |
|
| ttlSecondsAfterFinished は、実行が終了した (Complete または Failed のいずれか) Job の存続期間を制限します。このフィールドが設定されている場合、Job の終了後に ttlSecondsAfterFinished を設定すると、自動的に削除される可能性があります。ジョブが削除されると、そのライフサイクル保証 (ファイナライザーなど) が尊重されます。このフィールドが設定されていないと、ジョブが自動的に削除されません。このフィールドがゼロに設定されていると、ジョブは終了後すぐに削除できるようになります。 |
11.2.1.4. .spec.jobTemplate.spec.podFailurePolicy
- 説明
- PodFailurePolicy は、失敗した Pod が backoffLimit にどのように影響するかを説明します。
- 型
-
object
- 必須
-
rules
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| Pod 障害ポリシールールの一覧。ルールは順番に評価されます。ルールが Pod の障害に一致すると、残りのルールは無視されます。Pod の障害に一致するルールがない場合は、デフォルトの処理が適用されます。つまり、Pod の失敗のカウンターが増分され、backoffLimit に対してチェックされます。最大 20 個の要素が許可されます。 |
|
| PodFailurePolicyRule は、要件が満たされた場合に Pod の障害がどのように処理されるかを記述します。各ルールでは、onExitCodes と onPodConditions のいずれか 1 つを使用できますが、両方は使用できません。 |
11.2.1.5. .spec.jobTemplate.spec.podFailurePolicy.rules
- 説明
- Pod 障害ポリシールールの一覧。ルールは順番に評価されます。ルールが Pod の障害に一致すると、残りのルールは無視されます。Pod の障害に一致するルールがない場合は、デフォルトの処理が適用されます。つまり、Pod の失敗のカウンターが増分され、backoffLimit に対してチェックされます。最大 20 個の要素が許可されます。
- 型
-
array
11.2.1.6. .spec.jobTemplate.spec.podFailurePolicy.rules[]
- 説明
- PodFailurePolicyRule は、要件が満たされた場合に Pod の障害がどのように処理されるかを記述します。各ルールでは、onExitCodes と onPodConditions のいずれか 1 つを使用できますが、両方は使用できません。
- 型
-
object
- 必須
-
action
-
onPodConditions
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 要件が満たされた場合に Pod の障害に対して実行されるアクションを指定します。可能な値は次のとおりです。 - FailJob: Pod のジョブが失敗としてマークされ、実行中のすべての Pod が終了することを示します。- Ignore: .backoffLimit に対するカウンターがインクリメントされず、代替 Pod が作成されることを示します。- Count: Pod がデフォルトの方法で処理されることを示します。- .backoffLimit までカウンターがインクリメントされます。その他の値は、今後追加される予定です。クライアントはルールを省略して、不明なアクションに対応する必要があります。
使用可能な列挙値: - |
|
| PodFailurePolicyOnExitCodesRequirement は、コンテナー終了コードに基づいて失敗した Pod を処理するための要件を説明します。特に、各アプリケーションコンテナーの .state.termination.exitCode と init コンテナーのステータスを検索します。これは、Pod ステータスの .status.containerStatuses フィールドと .status.initContainerStatuses フィールドをそれぞれ検索します。正常に完了したコンテナー (終了コード 0) は、要件チェックから除外されます。 |
|
| Pod の条件に関する要件を表します。要件は Pod 条件パターンのリストとして表されます。少なくとも 1 つのパターンが実際の Pod の状態と一致する場合、要件は満たされます。最大 20 個の要素が許可されます。 |
|
| PodFailurePolicyOnPodConditionsPattern は、実際の Pod 条件タイプと一致するパターンを記述します。 |
11.2.1.7. .spec.jobTemplate.spec.podFailurePolicy.rules[].onExitCodes
- 説明
- PodFailurePolicyOnExitCodesRequirement は、コンテナー終了コードに基づいて失敗した Pod を処理するための要件を説明します。特に、各アプリケーションコンテナーの .state.termination.exitCode と init コンテナーのステータスを検索します。これは、Pod ステータスの .status.containerStatuses フィールドと .status.initContainerStatuses フィールドをそれぞれ検索します。正常に完了したコンテナー (終了コード 0) は、要件チェックから除外されます。
- 型
-
object
- 必須
-
operator
-
values
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 終了コードのチェックを指定された名前のコンテナーに制限します。null の場合、ルールはすべてのコンテナーに適用されます。指定する場合、Pod テンプレート内のコンテナー名または initContainer 名のいずれかと一致する必要があります。 |
|
| コンテナー終了コードと指定された値の関係を表します。正常に完了したコンテナー (終了コード 0) は、要件チェックから除外されます。可能な値は次のとおりです。 - In: 少なくとも 1 つのコンテナーの終了コードが指定の値のセット内にある場合、要件は満たされます ('containerName' フィールドからの制限がないコンテナーが複数ある場合は、複数の終了コードが存在する可能性があります)。- NotIn: 少なくとも 1 つのコンテナーの終了コードが指定の値のセット内にない場合、要件は満たされます ('containerName' フィールドからの制限がないコンテナーが複数ある場合は、複数の終了コードが存在する可能性があります)。その他の値は、今後追加される予定です。クライアントは、要件が満たされていないことを前提として、不明な演算子に対応する必要があります。
使用可能な列挙値: - |
|
| 値のセットを指定します。返された各コンテナー終了コードは、この値のセットに対して、演算子に関するチェックを行います (複数のコンテナーがある場合は複数存在する可能性があります)。値のリストは順序付けする必要があり、重複を含めることはできません。値 '0' は、In 演算子に使用できません。少なくとも 1 つの要素が必要です。最大 255 個の要素が許可されます。 |
11.2.1.8. .spec.jobTemplate.spec.podFailurePolicy.rules[].onPodConditions
- 説明
- Pod の条件に関する要件を表します。要件は Pod 条件パターンのリストとして表されます。少なくとも 1 つのパターンが実際の Pod の状態と一致する場合、要件は満たされます。最大 20 個の要素が許可されます。
- 型
-
array
11.2.1.9. .spec.jobTemplate.spec.podFailurePolicy.rules[].onPodConditions[]
- 説明
- PodFailurePolicyOnPodConditionsPattern は、実際の Pod 条件タイプと一致するパターンを記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 必要な Pod の条件ステータスを指定します。Pod 条件と一致するには、指定されたステータスが Pod 条件ステータスと等しい必要があります。デフォルトは True です。 |
|
| 必要な Pod 条件タイプを指定します。Pod 条件と一致するには、指定されたタイプが Pod 条件タイプと等しい必要があります。 |
11.2.1.10. .status
- 説明
- CronJobStatus は、cron ジョブの現在の状態を表します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| 現在実行中のジョブへのポインターのリスト。 | |
| この Job が最後に正常にスケジュールされた時刻情報。 | |
| この Job が最後に正常に完了した時刻情報。 |
11.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/batch/v1/cronjobs
-
GET
: CronJob 種類のオブジェクトをリスト表示または監視します
-
/apis/batch/v1/watch/cronjobs
-
GET
: CronJob のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs
-
削除
: CronJob のコレクションを削除する -
GET
: CronJob 種類のオブジェクトをリスト表示または監視します -
POST
: CronJob を作成する
-
/apis/batch/v1/watch/namespaces/{namespace}/cronjobs
-
GET
: CronJob のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
-
DELETE
: CronJob を削除する -
GET
: 指定された CronJob を読み取る -
PATCH
: 指定された CronJob を部分的に更新します -
PUT
: 指定された CronJob を置き換える
-
/apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}
-
GET
: CronJob 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
-
GET
: 指定された CronJob のステータスを読み取る -
PATCH
: 指定された CronJob のステータスを部分的に更新します -
PUT
: 指定された CronJob のステータスを置き換えます
-
11.2.2.1. /apis/batch/v1/cronjobs
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CronJob 種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.2.2.2. /apis/batch/v1/watch/cronjobs
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CronJob のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.2.2.3. /apis/batch/v1/namespaces/{namespace}/cronjobs
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CronJob のコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- CronJob 種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CronJob を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
11.2.2.4. /apis/batch/v1/watch/namespaces/{namespace}/cronjobs
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CronJob のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.2.2.5. /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CronJob の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CronJob を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された CronJob を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CronJob を部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CronJob を置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
11.2.2.6. /apis/batch/v1/watch/namespaces/{namespace}/cronjobs/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CronJob の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CronJob 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.2.2.7. /apis/batch/v1/namespaces/{namespace}/cronjobs/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| CronJob の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された CronJob のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CronJob のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CronJob のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
11.3. Job [batch/v1]
- 説明
- Job は、単一の Job の設定を表します。
- 型
-
object
11.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 を参照してください。 | |
|
| JobSpec は、ジョブの実行がどのようになるかを記述します。 |
|
| JobStatus は、ジョブの現在の状態を表します。 |
11.3.1.1. .spec
- 説明
- JobSpec は、ジョブの実行がどのようになるかを記述します。
- 型
-
object
- 必須
-
template
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| システムがジョブを終了しようとする前に、ジョブが継続的にアクティブになる可能性がある startTime を基準とした秒単位の期間を指定します。値は正の整数でなければなりません。ジョブが (作成時または更新中に) 一時停止になった場合、このタイマーは事実上停止となり、ジョブが再開したときにリセットされます。 |
|
| このジョブを失敗とマークするまでの再試行回数を指定します。デフォルトは 6 です。 |
|
|
completionMode は、Pod の完了を追跡する方法を指定します。
今後、さらに多くの完了モードを追加できます。ジョブコントローラーが認識できないモードを確認した場合、コントローラーはジョブの更新をスキップします。
可能な列挙値: |
|
| ジョブを実行するために正常に終了した Pod の希望数を指定します。null に設定すると、任意の Pod の成功がすべての Pod の成功を示し、並列処理に正の値を設定できるようになります。1 に設定すると、並列処理が 1 に制限され、その Pod の成功がジョブの成功を示します。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
|
manualSelector は、Pod ラベルと Pod セレクターの生成を制御します。何をしているのかわからない場合は、 |
|
| ジョブが任意の時点で実行する必要のある Pod の最大数を指定します。定常状態で実行している Pod の実際の数は、((.spec.completions - .status.successful) < .spec.parallelism) の場合、つまり、実行する必要のある作業が最大並列処理より少ない場合は、この数より少なくなります。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
| PodFailurePolicy は、失敗した Pod が backoffLimit にどのように影響するかを説明します。 |
| Pod 数と一致する必要がある Pod に対するラベルクエリー。通常、システムはこのフィールドを設定します。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | |
|
| suspend は、Job コントローラーが Pod を作成するかどうかを指定します。suspend を true に設定して Job を作成すると、ジョブコントローラーは Pod を作成しません。作成後に Job が一時停止した場合 (つまり、フラグが false から true になる場合)、Job コントローラーはこの Job に関連付けられているすべてのアクティブな Pod を削除します。ユーザーは、これを適切に処理するようにワークロードを設計する必要があります。ジョブを一時停止すると、ジョブの StartTime フィールドがリセットされ、ActiveDeadlineSeconds タイマーも効果的にリセットされます。デフォルトは false です。 |
| ジョブの実行時に作成される Pod を説明します。使用できる template.spec.restartPolicy の値は "Never" または "OnFailure" のみです。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | |
|
| ttlSecondsAfterFinished は、実行が終了した (Complete または Failed のいずれか) Job の存続期間を制限します。このフィールドが設定されている場合、Job の終了後に ttlSecondsAfterFinished を設定すると、自動的に削除される可能性があります。ジョブが削除されると、そのライフサイクル保証 (ファイナライザーなど) が尊重されます。このフィールドが設定されていないと、ジョブが自動的に削除されません。このフィールドがゼロに設定されていると、ジョブは終了後すぐに削除できるようになります。 |
11.3.1.2. .spec.podFailurePolicy
- 説明
- PodFailurePolicy は、失敗した Pod が backoffLimit にどのように影響するかを説明します。
- 型
-
object
- 必須
-
rules
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| Pod 障害ポリシールールの一覧。ルールは順番に評価されます。ルールが Pod の障害に一致すると、残りのルールは無視されます。Pod の障害に一致するルールがない場合は、デフォルトの処理が適用されます。つまり、Pod の失敗のカウンターが増分され、backoffLimit に対してチェックされます。最大 20 個の要素が許可されます。 |
|
| PodFailurePolicyRule は、要件が満たされた場合に Pod の障害がどのように処理されるかを記述します。各ルールでは、onExitCodes と onPodConditions のいずれか 1 つを使用できますが、両方は使用できません。 |
11.3.1.3. .spec.podFailurePolicy.rules
- 説明
- Pod 障害ポリシールールの一覧。ルールは順番に評価されます。ルールが Pod の障害に一致すると、残りのルールは無視されます。Pod の障害に一致するルールがない場合は、デフォルトの処理が適用されます。つまり、Pod の失敗のカウンターが増分され、backoffLimit に対してチェックされます。最大 20 個の要素が許可されます。
- 型
-
array
11.3.1.4. .spec.podFailurePolicy.rules[]
- 説明
- PodFailurePolicyRule は、要件が満たされた場合に Pod の障害がどのように処理されるかを記述します。各ルールでは、onExitCodes と onPodConditions のいずれか 1 つを使用できますが、両方は使用できません。
- 型
-
object
- 必須
-
action
-
onPodConditions
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 要件が満たされた場合に Pod の障害に対して実行されるアクションを指定します。可能な値は次のとおりです。 - FailJob: Pod のジョブが失敗としてマークされ、実行中のすべての Pod が終了することを示します。- Ignore: .backoffLimit に対するカウンターがインクリメントされず、代替 Pod が作成されることを示します。- Count: Pod がデフォルトの方法で処理されることを示します。- .backoffLimit までカウンターがインクリメントされます。その他の値は、今後追加される予定です。クライアントはルールを省略して、不明なアクションに対応する必要があります。
使用可能な列挙値: - |
|
| PodFailurePolicyOnExitCodesRequirement は、コンテナー終了コードに基づいて失敗した Pod を処理するための要件を説明します。特に、各アプリケーションコンテナーの .state.termination.exitCode と init コンテナーのステータスを検索します。これは、Pod ステータスの .status.containerStatuses フィールドと .status.initContainerStatuses フィールドをそれぞれ検索します。正常に完了したコンテナー (終了コード 0) は、要件チェックから除外されます。 |
|
| Pod の条件に関する要件を表します。要件は Pod 条件パターンのリストとして表されます。少なくとも 1 つのパターンが実際の Pod の状態と一致する場合、要件は満たされます。最大 20 個の要素が許可されます。 |
|
| PodFailurePolicyOnPodConditionsPattern は、実際の Pod 条件タイプと一致するパターンを記述します。 |
11.3.1.5. .spec.podFailurePolicy.rules[].onExitCodes
- 説明
- PodFailurePolicyOnExitCodesRequirement は、コンテナー終了コードに基づいて失敗した Pod を処理するための要件を説明します。特に、各アプリケーションコンテナーの .state.termination.exitCode と init コンテナーのステータスを検索します。これは、Pod ステータスの .status.containerStatuses フィールドと .status.initContainerStatuses フィールドをそれぞれ検索します。正常に完了したコンテナー (終了コード 0) は、要件チェックから除外されます。
- 型
-
object
- 必須
-
operator
-
values
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 終了コードのチェックを指定された名前のコンテナーに制限します。null の場合、ルールはすべてのコンテナーに適用されます。指定する場合、Pod テンプレート内のコンテナー名または initContainer 名のいずれかと一致する必要があります。 |
|
| コンテナー終了コードと指定された値の関係を表します。正常に完了したコンテナー (終了コード 0) は、要件チェックから除外されます。可能な値は次のとおりです。 - In: 少なくとも 1 つのコンテナーの終了コードが指定の値のセット内にある場合、要件は満たされます ('containerName' フィールドからの制限がないコンテナーが複数ある場合は、複数の終了コードが存在する可能性があります)。- NotIn: 少なくとも 1 つのコンテナーの終了コードが指定の値のセット内にない場合、要件は満たされます ('containerName' フィールドからの制限がないコンテナーが複数ある場合は、複数の終了コードが存在する可能性があります)。その他の値は、今後追加される予定です。クライアントは、要件が満たされていないことを前提として、不明な演算子に対応する必要があります。
使用可能な列挙値: - |
|
| 値のセットを指定します。返された各コンテナー終了コードは、この値のセットに対して、演算子に関するチェックを行います (複数のコンテナーがある場合は複数存在する可能性があります)。値のリストは順序付けする必要があり、重複を含めることはできません。値 '0' は、In 演算子に使用できません。少なくとも 1 つの要素が必要です。最大 255 個の要素が許可されます。 |
11.3.1.6. .spec.podFailurePolicy.rules[].onPodConditions
- 説明
- Pod の条件に関する要件を表します。要件は Pod 条件パターンのリストとして表されます。少なくとも 1 つのパターンが実際の Pod の状態と一致する場合、要件は満たされます。最大 20 個の要素が許可されます。
- 型
-
array
11.3.1.7. .spec.podFailurePolicy.rules[].onPodConditions[]
- 説明
- PodFailurePolicyOnPodConditionsPattern は、実際の Pod 条件タイプと一致するパターンを記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| 必要な Pod の条件ステータスを指定します。Pod 条件と一致するには、指定されたステータスが Pod 条件ステータスと等しい必要があります。デフォルトは True です。 |
|
| 必要な Pod 条件タイプを指定します。Pod 条件と一致するには、指定されたタイプが Pod 条件タイプと等しい必要があります。 |
11.3.1.8. .status
- 説明
- JobStatus は、ジョブの現在の状態を表します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 保留中および実行中の Pod の数。 |
|
| completedIndexes は、.spec.completionMode = "Indexed" の場合に完成したインデックスをテキスト形式で保持します。インデックスは、コンマで区切られた 10 進整数として表されます。番号は昇順でリストされています。3 つ以上の連続する数値は圧縮され、ハイフンで区切られたシリーズの最初と最後の要素で表されます。たとえば、完了したインデックスが 1、3、4、5、7 の場合は、"1,3-5,7" で表現されます。 |
| ジョブが完了した時間を表します。別々の操作をまたいで、happens-before の順序が設定されることは保証されていません。これは RFC3339 形式で表されます。これは UTC です。完了時間は、ジョブが正常に終了したときにのみ設定されます。 | |
|
| オブジェクトの現在の状態の最新の利用可能な観測。ジョブが失敗すると、条件の 1 つに "Failed" と入力され、ステータスが true になります。Job が一時停止すると、条件の 1 つのタイプが "Suspended" になり、ステータスが true になります。Job が再開すると、この状態のステータスは false になります。ジョブが完了すると、条件の 1 つのタイプが "Complete" になり、ステータスが true になります。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
|
| JobCondition は、ジョブの現在の状態を記述します。 |
|
| フェーズ失敗に達した Pod の数。 |
|
| Ready 状態の Pod 数。 このフィールドは、ベータレベルですジョブコントローラーは、JobReadyPods のフィーチャーゲートが有効になっている場合 (デフォルトで有効になっている場合)、フィールドにデータを入力します。 |
| ジョブコントローラーがジョブの処理を開始した時刻を表します。Job が一時停止状態で作成された場合、このフィールドは最初に再開されるまで設定されません。このフィールドは、Job が一時停止から再開するたびにリセットされます。これは RFC3339 形式で表されます。これは UTC です。 | |
|
| フェーズ成功に達した Pod の数。 |
|
| UncountedTerminatedPods は、終了したにもかかわらず Job ステータスカウンターに計上されていない Pod の UID を保持します。 |
11.3.1.9. .status.conditions
- 説明
- オブジェクトの現在の状態の最新の利用可能な観測。ジョブが失敗すると、条件の 1 つに "Failed" と入力され、ステータスが true になります。Job が一時停止すると、条件の 1 つのタイプが "Suspended" になり、ステータスが true になります。Job が再開すると、この状態のステータスは false になります。ジョブが完了すると、条件の 1 つのタイプが "Complete" になり、ステータスが true になります。詳細: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
- 型
-
array
11.3.1.10. .status.conditions[]
- 説明
- JobCondition は、ジョブの現在の状態を記述します。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| 前回条件がチェックされたとき。 | |
| 前回、状態が 1 つのステータスから別のステータスに移行したとき。 | |
|
| 最後にある状態から別の状態に遷移した時間。 |
|
| (簡単な) 条件の最後の遷移の理由。 |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| ジョブ条件のタイプ、完了または失敗。 |
11.3.1.11. .status.uncountedTerminatedPods
- 説明
- UncountedTerminatedPods は、終了したにもかかわらず Job ステータスカウンターに計上されていない Pod の UID を保持します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| failed は、失敗した Pod の UID を保持します。 |
|
| succeeded は、成功した Pod の UID を保持します。 |
11.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/batch/v1/jobs
-
GET
: Job 種類のオブジェクトをリスト表示または監視するロール
-
/apis/batch/v1/watch/jobs
-
GET
: Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/batch/v1/namespaces/{namespace}/jobs
-
DELETE
: Job のコレクションを削除します。 -
GET
: Job 種類のオブジェクトをリスト表示または監視するロール -
POST
: ジョブを作成する
-
/apis/batch/v1/watch/namespaces/{namespace}/jobs
-
GET
: Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/batch/v1/namespaces/{namespace}/jobs/{name}
-
DELETE
: Job を削除する -
GET
: 指定された Job を読み取ります。 -
PATCH
: 指定された Job を部分的に更新します。 -
PUT
: 指定された Job を置き換えます。
-
/apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
-
GET
: Job 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
-
GET
: 指定された Job のステータスを読み取ります。 -
PATCH
: 指定された Job のステータスを部分的に更新します。 -
PUT
: 指定された Job のステータスを置き換えます。
-
11.3.2.1. /apis/batch/v1/jobs
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Job 種類のオブジェクトをリスト表示または監視するロール
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.3.2.2. /apis/batch/v1/watch/jobs
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.3.2.3. /apis/batch/v1/namespaces/{namespace}/jobs
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- Job のコレクションを削除します。
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- Job 種類のオブジェクトをリスト表示または監視するロール
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- Job を作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
11.3.2.4. /apis/batch/v1/watch/namespaces/{namespace}/jobs
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Job のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.3.2.5. /apis/batch/v1/namespaces/{namespace}/jobs/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| Job の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- Job を削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された Job を読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Job を部分的に更新します。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された Job を置き換えます。
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
11.3.2.6. /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| Job の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- Job 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
11.3.2.7. /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| Job の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された Job のステータスを読み取る
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された Job のステータスを部分的に更新する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された Job のステータスを置き換える
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
第12章 証明書 API
12.1. 証明書 API
12.1.1. CertificateSigningRequest [certificates.k8s.io/v1]
- 説明
CertificateSigningRequest オブジェクトは、証明書署名要求を送信し、非同期で承認および発行することにより、x509 証明書を取得するメカニズムを提供します。
Kubelets はこの API を使用して以下を取得します。1。kube-apiserver に対して認証するクライアント証明書 ("kubernetes.io/kube-apiserver-client-kubelet" signerName を使用)。2. TLS エンドポイントのサービング証明書 kube-apiserver は安全に接続できます ("kubernetes.io/kubelet-serving" signerName を使用)。
この API を使用して、クライアント証明書に kube-apiserver への認証 ("kubernetes.io/kube-apiserver-client" signerName を使用) を要求したり、カスタムの非 Kubernetes 署名者から証明書を取得したりできます。
- 型
-
object
12.2. CertificateSigningRequest [certificates.k8s.io/v1]
- 説明
CertificateSigningRequest オブジェクトは、証明書署名要求を送信し、非同期で承認および発行することにより、x509 証明書を取得するメカニズムを提供します。
Kubelets はこの API を使用して以下を取得します。1。kube-apiserver に対して認証するクライアント証明書 ("kubernetes.io/kube-apiserver-client-kubelet" signerName を使用)。2. TLS エンドポイントのサービング証明書 kube-apiserver は安全に接続できます ("kubernetes.io/kubelet-serving" signerName を使用)。
この API を使用して、クライアント証明書に kube-apiserver への認証 ("kubernetes.io/kube-apiserver-client" signerName を使用) を要求したり、カスタムの非 Kubernetes 署名者から証明書を取得したりできます。
- 型
-
object
- 必須
-
spec
-
12.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 を参照してください。 |
| ||
|
| CertificateSigningRequestSpec には、証明書要求が含まれています。 |
|
| CertificateSigningRequestStatus には、リクエストの承認/拒否/失敗ステータス、および発行された証明書を示すために使用される条件が含まれています。 |
12.2.1.1. .spec
- 説明
- CertificateSigningRequestSpec には、証明書要求が含まれています。
- 型
-
object
- 必須
-
request
-
signerName
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| expirationSeconds は、発行された証明書の要求された有効期間です。証明書の署名者は、有効期間が異なる証明書を発行する場合があるため、クライアントは、発行された証明書の notBefore フィールドと notAfter フィールドの間のデルタをチェックして、実際の期間を決定する必要があります。 有名な Kubernetes 署名者の v1.22+ ツリー内実装は、要求された期間が、Kubernetes への --cluster-signing-duration CLI フラグに従って尊重する最大期間を超えない限り、このフィールドを尊重します。コントローラーマネージャー。 証明書の署名者は、さまざまな理由でこのフィールドを尊重しない場合があります。 1.フィールドを認識しない古い署名者 (v1.22 より前のツリー内実装など)2。設定された最大値が要求された期間より短い署名者 3。設定された最小値が要求された期間よりも長い署名者 expirationSeconds の有効な最小値は 600、つまり 10 分です。 |
|
| extra には、CertificateSigningRequest を作成したユーザーの追加属性が含まれます。作成時に API サーバーによって入力され、不変です。 |
|
| |
|
| groups には、CertificateSigningRequest を作成したユーザーのグループメンバーシップが含まれます。作成時に API サーバーによって入力され、不変です。 |
|
| 要求には、"CERTIFICATE REQUEST" PEM ブロックにエンコードされた x509 証明書署名要求が含まれています。JSON または YAML としてシリアル化される場合、データはさらに base64 でエンコードされます。 |
|
| signerName は、要求された署名者を示し、修飾された名前です。 CertificateSigningRequests のリスト/ウォッチリクエストは、"spec.signerName=NAME" fieldSelector を使用してこのフィールドでフィルタリングできます。 よく知られている Kubernetes 署名者は次のとおりです。1. "kubernetes.io/kube-apiserver-client": kube-apiserver への認証に使用できるクライアント証明書を発行します。この署名者のリクエストは、kube-controller-manager によって自動承認されることはなく、kube-controller-manager の "csrsigning" コントローラーによって発行できます。2. "kubernetes.io/kube-apiserver-client-kubelet": kubelets が kube-apiserver への認証に使用するクライアント証明書を発行します。この署名者のリクエストは、kube-controller-manager の "csrapproving" コントローラーによって自動承認され、kube-controller-manager の "csrsigning" コントローラーによって発行されます。3. "kubernetes.io/kubelet-serving" は、kubelet が TLS エンドポイントを提供するのに使用する証明書の提供を発行します。これは、kube-apiserver が安全に接続できます。この署名者のリクエストは、kube-controller-manager によって自動承認されることはなく、kube-controller-manager の "csrsigning" コントローラーによって発行できます。 詳細は、https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers を参照してください。 カスタム signerNames も指定できます。署名者は次のように定義します。1. 信頼の配布: 信頼 (CA バンドル) の配布方法。2. 許可された対象: および許可されていない対象が要求された場合の動作。3. 要求内の必須、許可、または禁止されている x509 拡張 (subjectAltNames が許可されているかどうか、どのタイプ、許可されている値の制限を含む)、および許可されていない拡張が要求された場合の動作。4. 必須、許可、または禁止されているキーの使用法/拡張キーの使用法。5. 有効期限/証明書の有効期間: 署名者によって修正されたかどうか、管理者によって設定可能かどうか。6. CA 証明書の要求が許可されるかどうか。 |
|
| uid には、CertificateSigningRequest を作成したユーザーの uid が含まれます。作成時に API サーバーによって入力され、不変です。 |
|
| 使用法は、発行された証明書で要求された一連の主要な使用法を指定します。 TLS クライアント証明書の要求は通常、"デジタル署名"、"キー暗号化"、"クライアント認証" を要求します。 TLS サービング証明書の要求は通常、"キー暗号化"、"デジタル署名"、"サーバー認証" を要求します。 有効な値は、"signing"、"digital signature"、"content commitment"、"key encipherment"、"key agreement"、"data encipherment"、"cert sign"、"crl sign"、"encipher only"、"decipher only"、"any"、"server auth"、"client auth"、"code signing"、"email protection"、"s/mime"、"ipsec end system"、"ipsec tunnel"、"ipsec user"、"timestamping"、"ocsp signing"、"microsoft sgc"、"netscape sgc" です。 |
|
| username には、CertificateSigningRequest を作成したユーザーの名前が含まれます。作成時に API サーバーによって入力され、不変です。 |
12.2.1.2. .spec.extra
- 説明
- extra には、CertificateSigningRequest を作成したユーザーの追加属性が含まれます。作成時に API サーバーによって入力され、不変です。
- 型
-
object
12.2.1.3. .status
- 説明
- CertificateSigningRequestStatus には、リクエストの承認/拒否/失敗ステータス、および発行された証明書を示すために使用される条件が含まれています。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 証明書には、承認済み条件が存在した後、署名者によって発行された証明書が入力されます。このフィールドは、/status サブリソースを介して設定されます。一度入力されると、このフィールドは不変です。 証明書署名要求が拒否された場合、タイプ "Denied" の条件が追加され、このフィールドは空のままになります。署名者が証明書を発行できない場合は、タイプ "Failed" の条件が追加され、このフィールドは空のままになります。 検証要件:1. 証明書には 1 つ以上の PEM ブロックが含まれている必要があります。2. すべての PEM ブロックには、"CERTIFICATE" ラベルが付いていて、ヘッダーが含まれていない必要があります。また、エンコードされたデータは、RFC5280 のセクション 4 で説明されている BER エンコードされた ASN.1 証明書構造である必要があります。3. 非 PEM コンテンツは、"CERTIFICATE" PEM ブロックの前または後に表示される場合があり、RFC7468 のセクション 5.2 で説明されている説明テキストを許可するために、検証されていません。 複数の PEM ブロックが存在し、要求された spec.signerName の定義がそれ以外を示さない場合、最初のブロックは発行された証明書であり、後続のブロックは中間証明書として扱われ、TLS ハンドシェイクで提示される必要があります。 証明書は PEM 形式でエンコードされています。 JSON または YAML としてシリアル化される場合、データはさらに base64 でエンコードされるため、次のもので構成されます。 base64( -----BEGIN CERTIFICATE----- … -----END CERTIFICATE----- ) |
|
| リクエストに適用される条件。既知の条件は、"Approved"、"Denied"、および "Failed" です。 |
|
| CertificateSigningRequestCondition は、CertificateSigningRequest オブジェクトの条件を記述します |
12.2.1.4. .status.conditions
- 説明
- リクエストに適用される条件。既知の条件は、"Approved"、"Denied"、および "Failed" です。
- 型
-
array
12.2.1.5. .status.conditions[]
- 説明
- CertificateSigningRequestCondition は、CertificateSigningRequest オブジェクトの条件を記述します
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。設定されていない場合、新しい条件タイプが追加されるか、既存の条件のステータスが変更されると、サーバーはこれを現在の時刻にデフォルト設定します。 | |
| lastUpdateTime は、この条件が最後に更新された時刻です。 | |
|
| メッセージには、リクエストの状態に関する詳細を含む人間が読めるメッセージが含まれています |
|
| reason は、リクエスト状態の簡単な理由を示します |
|
| 条件のステータス、True、False、Unknown のいずれか。承認、拒否、および失敗の条件は、"False" または "Unknown" ではない場合があります。 |
|
| 条件の型。既知の条件は、"Approved"、"Denied"、および "Failed" です。 "Approved" 条件は /approval サブリソースを介して追加され、要求が承認され、署名者が発行する必要があることを示します。 "Denied" は /approval サブリソースを介して追加され、要求が拒否されたため、署名者が発行してはならないことを示します。 "Failed" 条件が /status サブリソースを介して追加され、署名者が証明書の発行に失敗したことを示します。 承認された条件と拒否された条件は相互に排他的です。承認済み、拒否済み、および失敗した条件は、一度追加すると削除できません。 特定のタイプの条件は 1 つだけ許可されます。 |
12.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/certificates.k8s.io/v1/certificatesigningrequests
-
削除
:CertificateSigningRequest のコレクションを削除します -
GET
: 種類の CertificateSigningRequest のオブジェクトをリスト表示または監視します -
POST
:CertificateSigningRequest を作成します
-
/apis/certificates.k8s.io/v1/watch/certificatesigningrequests
-
GET
:CertificateSigningRequest のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
-
削除
:CertificateSigningRequest を削除します -
GET
: 指定された CertificateSigningRequest を読み取ります -
PATCH
: 指定された CertificateSigningRequest を部分的に更新します -
PUT
: 指定された CertificateSigningRequest を置き換えます
-
/apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}
-
GET
: 種類 CertificateSigningRequest のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
-
GET
: 指定された CertificateSigningRequest のステータスを読み取ります -
PATCH
: 指定された CertificateSigningRequest のステータスを部分的に更新します -
PUT
: 指定された CertificateSigningRequest のステータスを置き換えます
-
/apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval
-
GET
: 指定された CertificateSigningRequest の承認を読み取ります -
PATCH
: 指定された CertificateSigningRequest の承認を部分的に更新します -
PUT
: 指定された CertificateSigningRequest の承認を置き換えます
-
12.2.2.1. /apis/certificates.k8s.io/v1/certificatesigningrequests
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CertificateSigningRequest のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示または監視する CertificateSigningRequest
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- CertificateSigningRequest を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
202 - Accepted | |
401 - Unauthorized | 空白 |
12.2.2.2. /apis/certificates.k8s.io/v1/watch/certificatesigningrequests
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- CertificateSigningRequest のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
12.2.2.3. /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CertificateSigningRequest の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- CertificateSigningRequest を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された CertificateSigningRequest を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CertificateSigningRequest を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CertificateSigningRequest を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
12.2.2.4. /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| CertificateSigningRequest の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類 CertificateSigningRequest のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
12.2.2.5. /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
パラメーター | 型 | 説明 |
---|---|---|
|
| CertificateSigningRequest の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された CertificateSigningRequest のステータスを読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CertificateSigningRequest のステータスを部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CertificateSigningRequest のステータスを置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
12.2.2.6. /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval
パラメーター | 型 | 説明 |
---|---|---|
|
| CertificateSigningRequest の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された CertificateSigningRequest の承認を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された CertificateSigningRequest の承認を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された CertificateSigningRequest の承認を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK | |
201 - Created | |
401 - Unauthorized | 空白 |
第13章 調整 API
13.1. 調整 API
13.1.1. リース [coordination.k8s.io/v1]
- 説明
- リースは、リースの概念を定義します。
- 型
-
object
13.2. リース [coordination.k8s.io/v1]
- 説明
- リースは、リースの概念を定義します。
- 型
-
object
13.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 を参照してください。 | |
|
| LeaseSpec は、Lease の仕様です。 |
13.2.1.1. .spec
- 説明
- LeaseSpec は、Lease の仕様です。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
| acquireTime は、現在のリースが取得された時刻です。 | |
|
| holderIdentity には、現在のリースの所有者の ID が含まれます。 |
|
| leaseDurationSeconds は、リースの候補者がそれを強制的に取得するのを待つ必要がある期間です。これは、最後に確認された renewTime の時間に対する測定値です。 |
|
| leaseTransitions は、所有者間のリースの遷移の数です。 |
| renewTime は、リースの現在の所有者が最後にリースを更新した時刻です。 |
13.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/coordination.k8s.io/v1/leases
-
GET
: 種類のオブジェクトをリスト表示または監視するリース
-
/apis/coordination.k8s.io/v1/watch/leases
-
GET
: リースのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
-
DELETE
: リースのコレクションを削除します -
GET
: 種類のオブジェクトをリスト表示または監視するリース -
POST
: リースを作成します
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases
-
GET
: リースのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
-
削除
: リースを削除します -
GET
: 指定されたリースを読み取ります -
PATCH
: 指定されたリースを部分的に更新します -
PUT
: 指定されたリースを置き換えます
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}
-
GET
: リースの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
13.2.2.1. /apis/coordination.k8s.io/v1/leases
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示または監視するリース
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
13.2.2.2. /apis/coordination.k8s.io/v1/watch/leases
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- リースのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
13.2.2.3. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- リースのコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- リースを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
13.2.2.4. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- リースのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
13.2.2.5. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
13.2.2.6. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類のリースのオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
第14章 コア API
14.1. コア API
14.1.1. バインディング [v1]
- 説明
- バインディングは、あるオブジェクトを別のオブジェクトに結び付けます。たとえば、Pod はスケジューラーによってノードにバインドされます。1.7 で非推奨になりました。代わりに、Pod のバインディングサブリソースを使用してください。
- 型
-
object
14.1.2. ComponentStatus [v1]
- 説明
- ComponentStatus (および ComponentStatusList) は、クラスター検証情報を保持します。非推奨: この API は v1.19+ で非推奨となりました。
- 型
-
object
14.1.3. ConfigMap [v1]
- 説明
- ConfigMap は、Pod が使用する設定データを保持します。
- 型
-
object
14.1.4. Endpoints [v1]
- 説明
エンドポイントは、実際のサービスを実装するエンドポイントのコレクションです。以下に例を示します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]
Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]
- 型
-
object
14.1.5. Event [v1]
- 説明
- イベントは、クラスター内のどこかにあるイベントのレポートです。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。
- 型
-
object
14.1.6. LimitRange [v1]
- 説明
- LimitRange は、名前空間内のリソースの種類ごとにリソース使用制限を設定します。
- 型
-
object
14.1.7. Namespace [v1]
- 説明
- 名前空間は、名前のスコープを提供します。複数の名前空間の使用はオプションです。
- 型
-
object
14.1.8. Node [v1]
- 説明
- Node は Kubernetes のワーカーノードです。各ノードは、キャッシュ内 (つまり、etcd 内) に一意の識別子を持ちます。
- 型
-
object
14.1.9. PersistentVolume [v1]
- 説明
- PersistentVolume (PV) は、管理者によってプロビジョニングされたストレージリソースです。これはノードに似ています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes
- 型
-
object
14.1.10. PersistentVolumeClaim [v1]
- 説明
- PersistentVolumeClaim は、永続ボリュームに対するユーザーの要求および要求です。
- 型
-
object
14.1.11. Pod [v1]
- 説明
- Pod は、ホスト上で実行できるコンテナーのコレクションです。このリソースはクライアントによって作成され、ホストにスケジュールされます。
- 型
-
object
14.1.12. PodTemplate [v1]
- 説明
- PodTemplate は、事前定義された Pod のコピーを作成するためのテンプレートを記述します。
- 型
-
object
14.1.13. ReplicationController [v1]
- 説明
- ReplicationController は、レプリケーションコントローラーの設定を表します。
- 型
-
object
14.1.14. ResourceQuota [v1]
- 説明
- ResourceQuota は、名前空間ごとに適用される集約クォータ制限を設定します
- 型
-
object
14.1.15. Secret [v1]
- 説明
- Secret は特定のタイプのシークレットデータを保持します。Data フィールドの値の合計バイト数は MaxSecretSize バイト未満である必要があります。
- 型
-
object
14.1.16. Service [v1]
- 説明
- サービスは、プロキシーがリッスンするローカルポート (たとえば 3306) と、プロキシーを介して送信された要求に応答する Pod を決定するセレクターで構成されるソフトウェアサービス (たとえば、mysql) の名前付き抽象化です。
- 型
-
object
14.1.17. ServiceAccount [v1]
- 説明
- ServiceAccount は互いにバインドします:*ユーザーおよびおそらく周辺システムによって理解される ID の名前*認証および承認できるプリンシパル*一連のシークレット
- 型
-
object
14.2. バインディング [v1]
- 説明
- バインディングは、あるオブジェクトを別のオブジェクトに結び付けます。たとえば、Pod はスケジューラーによってノードにバインドされます。1.7 で非推奨になりました。代わりに、Pod のバインディングサブリソースを使用してください。
- 型
-
object
- 必須
-
target
-
14.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 を参照してください。 | |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
14.2.1.1. .target
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.2.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/namespaces/{namespace}/bindings
-
POST
: バインディングを作成します
-
/api/v1/namespaces/{namespace}/pods/{name}/binding
-
POST
:Pod のバインディングを作成します
-
14.2.2.1. /api/v1/namespaces/{namespace}/bindings
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- バインディングを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.2.2.2. /api/v1/namespaces/{namespace}/pods/{name}/binding
パラメーター | 型 | 説明 |
---|---|---|
|
| バインディングの名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
POST
- 説明
- Pod のバインディングを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.3. ComponentStatus [v1]
- 説明
- ComponentStatus (および ComponentStatusList) は、クラスター検証情報を保持します。非推奨: この API は v1.19+ で非推奨となりました。
- 型
-
object
14.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 を参照してください。 |
14.3.1.1. .conditions
- 説明
- 観察されたコンポーネント条件のリスト
- 型
-
array
14.3.1.2. .conditions[]
- 説明
- コンポーネントの状態に関する情報。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| コンポーネントの条件エラーコード。たとえば、ヘルスチェックのエラーコード。 |
|
| コンポーネントの状態に関するメッセージ。たとえば、ヘルスチェックに関する情報。 |
|
| コンポーネントの状態のステータス。"Healthy" の有効な値: "True"、"False"、または "Unknown"。 |
|
| コンポーネントの条件のタイプ。有効な値: "Healthy" |
14.3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/componentstatuses
-
GET
: 種類のオブジェクトをリスト表示する ComponentStatus
-
/api/v1/componentstatuses/{name}
-
GET
: 指定された ComponentStatus を読み取ります
-
14.3.2.1. /api/v1/componentstatuses
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示する ComponentStatus
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.3.2.2. /api/v1/componentstatuses/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ComponentStatus の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
GET
- 説明
- 指定された ComponentStatus を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.4. ConfigMap [v1]
- 説明
- ConfigMap は、Pod が使用する設定データを保持します。
- 型
-
object
14.4.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| BinaryData には、バイナリーデータが含まれています。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。BinaryData には、UTF-8 の範囲にないバイトシーケンスを含めることができます。BinaryData に格納されているキーは、データフィールドのキーと重複してはなりません。これは、検証プロセス中に適用されます。このフィールドを使用するには、1.10 以降の apiserver と kubelet が必要です。 |
|
| 設定データが含まれます。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。非 UTF-8 バイトシーケンスの値は、BinaryData フィールドを使用する必要があります。データに保存されているキーは、BinaryData フィールドのキーと重複してはなりません。これは検証プロセス中に適用されます。 |
|
| Immutable を true に設定すると、ConfigMap に保存されているデータは更新できなくなります (オブジェクトのメタデータのみを変更できます)。true に設定されていない場合、いつでもフィールドを変更できます。デフォルトは nil です。 |
|
| 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 を参照してください。 |
14.4.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/configmaps
-
GET
:ConfigMap の種類のオブジェクトをリスト表示または監視します
-
/api/v1/watch/configmaps
-
GET
:ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/configmaps
-
DELETE
:ConfigMap のコレクションを削除します -
GET
:ConfigMap の種類のオブジェクトをリスト表示または監視します -
POST
:ConfigMap を作成します
-
/api/v1/watch/namespaces/{namespace}/configmaps
-
GET
:ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/configmaps/{name}
-
削除
:ConfigMap を削除します -
GET
: 指定された ConfigMap を読み取ります -
PATCH
: 指定された ConfigMap を部分的に更新します -
PUT
: 指定された ConfigMap を置き換えます
-
/api/v1/watch/namespaces/{namespace}/configmaps/{name}
-
GET
:ConfigMap の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
14.4.2.1. /api/v1/configmaps
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ConfigMap の種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.4.2.2. /api/v1/watch/configmaps
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.4.2.3. /api/v1/namespaces/{namespace}/configmaps
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ConfigMap のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- ConfigMap の種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- ConfigMap を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.4.2.4. /api/v1/watch/namespaces/{namespace}/configmaps
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.4.2.5. /api/v1/namespaces/{namespace}/configmaps/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ConfigMap の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- ConfigMap を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された ConfigMap を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された ConfigMap を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された ConfigMap を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.4.2.6. /api/v1/watch/namespaces/{namespace}/configmaps/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| ConfigMap の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- ConfigMap の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.5. Endpoints [v1]
- 説明
エンドポイントは、実際のサービスを実装するエンドポイントのコレクションです。以下に例を示します。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]
Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ]
- 型
-
object
14.5.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| すべてのエンドポイントのセットは、すべてのサブセットの和集合です。アドレスは、共有する IP に従ってサブセットに配置されます。複数のポートを持つ単一のアドレス。一部は準備ができており、一部は準備ができていません (異なるコンテナーからのものであるため)。その結果、アドレスは異なるポートの異なるサブセットに表示されます。同じサブセットの Addresses と NotReadyAddresses の両方にアドレスは表示されません。サービスを構成するアドレスとポートのセット。 |
|
| EndpointSubset は、共通のポートセットを持つアドレスのグループです。拡張されたエンドポイントのセットは、アドレス x ポートのデカルト積です。たとえば、次のようになります。 { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } 結果として作成されるエンドポイントは以下のように表示できます。 a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ] |
14.5.1.1. .subsets
- 説明
- すべてのエンドポイントのセットは、すべてのサブセットの和集合です。アドレスは、共有する IP に従ってサブセットに配置されます。複数のポートを持つ単一のアドレス。一部は準備ができており、一部は準備ができていません (異なるコンテナーからのものであるため)。その結果、アドレスは異なるポートの異なるサブセットに表示されます。同じサブセットの Addresses と NotReadyAddresses の両方にアドレスは表示されません。サービスを構成するアドレスとポートのセット。
- 型
-
array
14.5.1.2. .subsets[]
- 説明
EndpointSubset は、共通のポートセットを持つアドレスのグループです。拡張されたエンドポイントのセットは、アドレス x ポートのデカルト積です。たとえば、次のようになります。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }
{ Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }
結果として作成されるエンドポイントは以下のように表示できます。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]
a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ]
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 準備完了としてマークされた関連ポートを提供する IP アドレス。これらのエンドポイントは、ロードバランサーとクライアントが利用するのに安全であると見なす必要があります。 |
|
| EndpointAddress は、単一の IP アドレスを記述するタプルです。 |
|
| 関連するポートを提供しているが、開始がまだ完了していないか、最近準備チェックに失敗したか、最近活性チェックに失敗したために現在準備完了としてマークされていない IP アドレス。 |
|
| EndpointAddress は、単一の IP アドレスを記述するタプルです。 |
|
| 関連する IP アドレスで使用可能なポート番号。 |
|
| EndpointPort は、単一のポートを記述するタプルです。 |
14.5.1.3. .subsets[].addresses
- 説明
- 準備完了としてマークされた関連ポートを提供する IP アドレス。これらのエンドポイントは、ロードバランサーとクライアントが利用するのに安全であると見なす必要があります。
- 型
-
array
14.5.1.4. .subsets[].addresses[]
- 説明
- EndpointAddress は、単一の IP アドレスを記述するタプルです。
- 型
-
object
- 必須
-
ip
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| このエンドポイントのホスト名 |
|
| このエンドポイントの IP。loopback (127.0.0.0/8 or ::1)、link-local (169.254.0.0/16 または fe80::/10)、link-local multicast (224.0.0.0/24 or ff02::/16) は使用できません。 |
|
| オプション: このエンドポイントをホストしているノード。これを使用して、ノードにローカルなエンドポイントを判別できます。 |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
14.5.1.5. .subsets[].addresses[].targetRef
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.5.1.6. .subsets[].notReadyAddresses
- 説明
- 関連するポートを提供しているが、開始がまだ完了していないか、最近準備チェックに失敗したか、最近活性チェックに失敗したために現在準備完了としてマークされていない IP アドレス。
- 型
-
array
14.5.1.7. .subsets[].notReadyAddresses[]
- 説明
- EndpointAddress は、単一の IP アドレスを記述するタプルです。
- 型
-
object
- 必須
-
ip
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| このエンドポイントのホスト名 |
|
| このエンドポイントの IP。loopback (127.0.0.0/8 or ::1)、link-local (169.254.0.0/16 または fe80::/10)、link-local multicast (224.0.0.0/24 or ff02::/16) は使用できません。 |
|
| オプション: このエンドポイントをホストしているノード。これを使用して、ノードにローカルなエンドポイントを判別できます。 |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
14.5.1.8. .subsets[].notReadyAddresses[].targetRef
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.5.1.9. .subsets[].ports
- 説明
- 関連する IP アドレスで使用可能なポート番号。
- 型
-
array
14.5.1.10. .subsets[].ports[]
- 説明
- EndpointPort は、単一のポートを記述するタプルです。
- 型
-
object
- 必須
-
port
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| このポートのアプリケーションプロトコル。これは、実装が理解できるプロトコルの動作をさらに多く提供できるようにヒントとして使用されます。このフィールドは、標準の Kubernetes ラベル構文に従います。有効な値は以下のいずれかになります。 * 接頭辞のないプロトコル名 - IANA 標準サービス名用に予約されています (RFC-6335 および https://www.iana.org/assignments/service-names に準拠)。 * Kubernetes 定義の接頭辞付きの名前: * 'kubernetes.io/h2c' - https://www.rfc-editor.org/rfc/rfc7540 で説明されている http/2 over cleartext。 * 他のプロトコルは、mycompany.com/my-custom-protocol など、実装定義の接頭辞名を使用する必要があります。 |
|
| このポートの名前。これは、対応する ServicePort の 'name' フィールドと一致する必要があります。DNS_LABEL である必要があります。1 つのポートが定義されている場合のみオプション。 |
|
| エンドポイントのポート番号。 |
|
| このポートの IP プロトコル。UDP、TCP、または SCTP である必要があります。デフォルトは TCP です。
使用可能な列挙値: - |
14.5.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/endpoints
-
GET
: エンドポイントの種類のオブジェクトをリスト表示または監視する
-
/api/v1/watch/endpoints
-
GET
: エンドポイントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/endpoints
-
削除
: エンドポイントのコレクションを削除します -
GET
: エンドポイントの種類のオブジェクトをリスト表示または監視する -
POST
: エンドポイントを作成します
-
/api/v1/watch/namespaces/{namespace}/endpoints
-
GET
: エンドポイントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/endpoints/{name}
-
削除
: エンドポイントを削除します -
GET
: 指定されたエンドポイントを読み取ります -
PATCH
: 指定されたエンドポイントを部分的に更新します -
PUT
: 指定されたエンドポイントを置き換えます
-
/api/v1/watch/namespaces/{namespace}/endpoints/{name}
-
GET
: エンドポイントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
14.5.2.1. /api/v1/endpoints
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類のエンドポイントのオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.5.2.2. /api/v1/watch/endpoints
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- エンドポイントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.5.2.3. /api/v1/namespaces/{namespace}/endpoints
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- エンドポイントのコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- エンドポイントを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.5.2.4. /api/v1/watch/namespaces/{namespace}/endpoints
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- エンドポイントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.5.2.5. /api/v1/namespaces/{namespace}/endpoints/{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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.5.2.6. /api/v1/watch/namespaces/{namespace}/endpoints/{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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- エンドポイントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.6. Event [v1]
- 説明
- イベントは、クラスター内のどこかにあるイベントのレポートです。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。
- 型
-
object
- 必須
-
metadata
-
involvedObject
-
14.6.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| Regarding オブジェクトに関して実行/失敗したアクション。 |
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| このイベントが発生した回数 |
| このイベントが最初に観測された時刻。 | |
| イベントが最初に記録された時間(サーバーの受信時刻は TypeMeta にあります。) | |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
| 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 を参照してください。 | |
|
| これは、オブジェクトの現在のステータスに移行する理由を示す、マシンが理解できる短い文字列である必要があります。 |
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
|
このイベントを発行したコントローラーの名前 (例: |
|
|
コントローラーインスタンスの ID(例: |
|
| EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。 |
|
| EventSource にはイベントの情報が含まれます。 |
|
| このイベントのタイプ (通常、警告)、将来的に新しいタイプが追加される可能性があります |
14.6.1.1. .involvedObject
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 参照先の API バージョン。 |
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
14.6.1.3. .series
- 説明
- EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 最後のハートビート時間までのこのシリーズの発生数 |
| 観測された最後の発生時刻 |
14.6.1.4. .source
- 説明
- EventSource にはイベントの情報が含まれます。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| イベントの生成元となるコンポーネント。 |
|
| イベントが生成されるノード名。 |
14.6.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/events
-
GET
: イベントの種類のオブジェクトをリスト表示または監視する
-
/api/v1/watch/events
-
GET
: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/events
-
DELETE
: イベントのコレクションを削除します -
GET
: イベントの種類のオブジェクトをリスト表示または監視する -
POST
: イベントを作成します
-
/api/v1/watch/namespaces/{namespace}/events
-
GET
: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/events/{name}
-
削除
: イベントを削除します -
GET
: 指定されたイベントを読み取ります -
PATCH
: 指定されたイベントを部分的に更新します -
PUT
: 指定されたイベントを置き換えます
-
/api/v1/watch/namespaces/{namespace}/events/{name}
-
GET
: イベントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
14.6.2.1. /api/v1/events
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 種類のオブジェクトをリスト表示または監視するイベント
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.6.2.2. /api/v1/watch/events
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.6.2.3. /api/v1/namespaces/{namespace}/events
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- イベントのコレクションを削除する
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- イベントを作成する
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.6.2.4. /api/v1/watch/namespaces/{namespace}/events
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.6.2.5. /api/v1/namespaces/{namespace}/events/{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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.6.2.6. /api/v1/watch/namespaces/{namespace}/events/{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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- イベントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.7. LimitRange [v1]
- 説明
- LimitRange は、名前空間内のリソースの種類ごとにリソース使用制限を設定します。
- 型
-
object
14.7.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| LimitRangeSpec は、種類が一致するリソースの最小/最大使用制限を定義します。 |
14.7.1.1. .spec
- 説明
- LimitRangeSpec は、種類が一致するリソースの最小/最大使用制限を定義します。
- 型
-
object
- 必須
-
limits
-
プロパティー | タイプ | 説明 |
---|---|---|
|
| Limits は、適用される LimitRangeItem オブジェクトのリストです。 |
|
| LimitRangeItem は、種類が一致するリソースの最小/最大使用制限を定義します。 |
14.7.1.2. .spec.limits
- 説明
- Limits は、適用される LimitRangeItem オブジェクトのリストです。
- 型
-
array
14.7.1.3. .spec.limits[]
- 説明
- LimitRangeItem は、種類が一致するリソースの最小/最大使用制限を定義します。
- 型
-
object
- 必須
-
type
-
プロパティー | タイプ | 説明 |
---|---|---|
| リソース制限が省略されている場合の、リソース名によるデフォルトのリソース要件制限値。 | |
| DefaultRequest は、リソース要求が省略された場合の、リソース名によるデフォルトのリソース要件要求値です。 | |
| リソース名によるこの種類の最大使用制限。 | |
| MaxLimitRequestRatio を指定する場合、指定されたリソースには、両方ともゼロ以外の要求と制限が必要です。制限を要求で割った値が列挙値以下の場合。これは、指定されたリソースの最大バーストを表します。 | |
| リソース名によるこの種類の最小使用制限。 | |
|
| この制限が適用されるリソースのタイプ。 |
14.7.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/limitranges
-
GET
:LimitRange の種類のオブジェクトをリスト表示または監視します
-
/api/v1/watch/limitranges
-
GET
: LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/limitranges
-
DELETE
:LimitRange のコレクションを削除します -
GET
:LimitRange の種類のオブジェクトをリスト表示または監視します -
POST
:LimitRange を作成します
-
/api/v1/watch/namespaces/{namespace}/limitranges
-
GET
: LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/limitranges/{name}
-
削除
:LimitRange を削除します -
GET
: 指定された LimitRange を読み取ります -
PATCH
: 指定された LimitRange を部分的に更新します -
PUT
: 指定された LimitRange を置き換えます
-
/api/v1/watch/namespaces/{namespace}/limitranges/{name}
-
GET
:LimitRange の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
14.7.2.1. /api/v1/limitranges
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- LimitRange の種類のオブジェクトをリスト表示または監視する
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.7.2.2. /api/v1/watch/limitranges
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.7.2.3. /api/v1/namespaces/{namespace}/limitranges
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- LimitRange のコレクションを削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| サーバーからさらに結果を取得する場合は、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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET
- 説明
- LimitRange の種類のオブジェクトをリスト表示または監視する
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- LimitRange を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.7.2.4. /api/v1/watch/namespaces/{namespace}/limitranges
パラメーター | 型 | 説明 |
---|---|---|
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- LimitRange のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.7.2.5. /api/v1/namespaces/{namespace}/limitranges/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| LimitRange の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
DELETE
- 説明
- LimitRange を削除します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。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
- 説明
- 指定された LimitRange を読み取ります
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH
- 説明
- 指定された LimitRange を部分的に更新します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、apply 要求 (application/apply-patch) の場合は必須ですが、apply 以外のパッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) の場合は任意です。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| "force" は、Apply 要求を強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合は、強制フラグを設定解除する必要があります。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT
- 説明
- 指定された LimitRange を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.7.2.6. /api/v1/watch/namespaces/{namespace}/limitranges/{name}
パラメーター | 型 | 説明 |
---|---|---|
|
| LimitRange の名前 |
|
| チームやプロジェクトなどのオブジェクト名と認証スコープ |
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- LimitRange の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.8. Namespace [v1]
- 説明
- 名前空間は、名前のスコープを提供します。複数の名前空間の使用はオプションです。
- 型
-
object
14.8.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| NamespaceSpec は、名前空間の属性を記述します。 |
|
| NamespaceStatus は、ネームスペースの現在のステータスに関する情報です。 |
14.8.1.1. .spec
- 説明
- NamespaceSpec は、名前空間の属性を記述します。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| ファイナライザーは、オブジェクトをストレージから完全に削除するために空にする必要がある不透明な値のリストです。詳細: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
14.8.1.2. .status
- 説明
- NamespaceStatus は、ネームスペースの現在のステータスに関する情報です。
- 型
-
object
プロパティー | タイプ | 説明 |
---|---|---|
|
| 名前空間の現在の状態の最新の利用可能な観測を表します。 |
|
| NamespaceCondition には、名前空間の状態の詳細が含まれます。 |
|
| フェーズは、名前空間の現在のライフサイクルフェーズです。詳細: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
使用可能な列挙値: - |
14.8.1.3. .status.conditions
- 説明
- 名前空間の現在の状態の最新の利用可能な観測を表します。
- 型
-
array
14.8.1.4. .status.conditions[]
- 説明
- NamespaceCondition には、名前空間の状態の詳細が含まれます。
- 型
-
object
- 必須
-
type
-
status
-
プロパティー | タイプ | 説明 |
---|---|---|
| ||
|
| |
|
| |
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
| 名前空間コントローラーの状態のタイプ。 |
14.8.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/namespaces
-
GET
: 名前空間の種類のオブジェクトをリスト表示または監視します -
POST
: 名前空間を作成します
-
/api/v1/watch/namespaces
-
GET
: 名前空間のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{name}
-
DELETE
: 名前空間を削除します -
GET
: 指定された名前空間を読み取ります -
PATCH
: 指定された名前空間を部分的に更新します -
PUT
: 指定された名前空間を置き換えます
-
/api/v1/watch/namespaces/{name}
-
GET
: 名前空間の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/api/v1/namespaces/{name}/status
-
GET
: 指定された名前空間のステータスを読み取ります -
PATCH
: 指定された名前空間のステータスを部分的に更新します -
PUT
: 指定された名前空間のステータスを置き換えます
-
/api/v1/namespaces/{name}/finalize
-
PUT
: 指定された名前空間のファイナライズを置き換えます
-
14.8.2.1. /api/v1/namespaces
パラメーター | 型 | 説明 |
---|---|---|
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST
- 説明
- namespace を作成します
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空白 |
14.8.2.2. /api/v1/watch/namespaces
パラメーター | 型 | 説明 |
---|---|---|
|
| 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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 名前空間のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.8.2.3. /api/v1/namespaces/{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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.8.2.4. /api/v1/watch/namespaces/{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 です。 |
|
| `sendInitialEvents=true` may be set together with `watch=true`.その場合、監視ストリームは合成イベントで始まり、コレクション内のオブジェクトの現在の状態を生成します。このようなイベントがすべて送信されると、合成的 "Bookmark" イベントが送信されます。ブックマークはオブジェクトのセットに対応する ResourceVersion (RV) を報告し、`"k8s.io/initial-events-end": "true"` アノテーションが付けられます。その後、監視ストリームは通常どおり続行され、(RV に続く) 変更に対応する監視イベントが監視対象のオブジェクトに送信されます。 'sendInitialEvents' オプションが設定されている場合は、'resourceVersionMatch' オプションも設定する必要があります。監視リクエストのセマンティクスとして、'resourceVersionMatch' = NotOlderThan は、"最低でも、指定された 'resourceVersion' と同程度に新しいデータ" として解釈され、最低でも状態が ListOptions が指定したものと同程度に新しい 'resourceVersion' に同期される場合にブックバークイベントが送信されます。`resourceVersion` が設定されていない場合、"consistent read" として解釈され、少なくともリクエストの処理が開始された瞬間までの状態が同期されると、ブックマークイベントが送信されます。- `resourceVersionMatch` を他の値に設定するか、未設定にすると、無効なエラーが返されます。 `resourceVersion=""` または `resourceVersion="0"` (下位互換性の目的) の場合、デフォルトは true、それ以外の場合は false です。 |
|
| リスト/ウォッチ呼び出しのタイムアウト。これにより、アクティビティーの有無に関係なく、呼び出し時間が制限されます。 |
|
| 記述されたリソースへの変更を監視し、追加、更新、および削除通知のストリームとして返します。resourceVersion を指定します。 |
- HTTP メソッド
-
GET
- 説明
- 名前空間の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
401 - Unauthorized | 空白 |
14.8.2.5. /api/v1/namespaces/{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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- 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 は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.8.2.6. /api/v1/namespaces/{name}/finalize
パラメーター | 型 | 説明 |
---|---|---|
|
| 名前空間の名前 |
パラメーター | 型 | 説明 |
---|---|---|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
|
| 'true' の場合は、出力が整形表示 (Pretty-print) されます。 |
- HTTP メソッド
-
PUT
- 説明
- 指定された名前空間の finalize を置き換えます
パラメーター | 型 | 説明 |
---|---|---|
|
|
HTTP コード | レスポンスのボディー |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空白 |
14.9. Node [v1]
- 説明
- Node は Kubernetes のワーカーノードです。各ノードは、キャッシュ内 (つまり、etcd 内) に一意の識別子を持ちます。
- 型
-
object
14.9.1. 仕様
プロパティー | タイプ | 説明 |
---|---|---|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
| NodeSpec は、ノードの作成に使用される属性を記述します。 |
|
| NodeStatus は、ノードの現在のステータスに関する情報です。 |
14.9.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 |
14.9.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 |
14.9.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 は |