8.14. Ingress [config.openshift.io/v1]
- Description
-
Ingress は、ルートに使用されるデフォルトの入力ドメインを含む、入力に関するクラスター全体の情報を保持します。正規名は
clusterです。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - タイプ
-
object - 必須
-
spec
-
8.14.1. 仕様 リンクのコピーリンクがクリップボードにコピーされました!
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。CamelCase詳細については、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| spec 設定についてのユーザーが設定できる値を保持します。 |
|
|
| status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。 |
8.14.1.1. .spec リンクのコピーリンクがクリップボードにコピーされました!
- Description
- spec 設定についてのユーザーが設定できる値を保持します。
- タイプ
-
object
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| appsDomain は、明示的なホストを指定せずにルートを作成するときに、ドメインフィールドで指定されたドメインの代わりに使用するオプションのドメインです。appsDomain が空でない場合、この値は Route のデフォルトのホスト値を生成するために使用されます。ドメインとは異なり、appsDomain はインストール後に変更される場合があります。これは、新しい ingresscontroller がワイルドカード証明書を使用してセットアップされていることを前提としています。 |
|
|
| componentRoutes は、クラスター管理者がホスト名とサービング証明書を設定できる OpenShift コンポーネントによって管理されるルートのオプションのリストです。このリストの各ルートの名前空間と名前は、status.componentRoutes リストの既存のエントリーと一致する必要があります。設定可能なルートのセットを判別するには、.status.componentRoutes リストの名前空間とエントリーの名前を確認します。ここで、参加している Operator が設定可能なルートのステータスを書き込みます。 |
|
|
| ComponentRouteSpec を使用すると、ルートのホスト名とサービング証明書を設定できます。 |
|
|
| ドメインは、ルートのホスト名が空の場合に、ルートのデフォルトのホスト名を生成するために使用されます。生成されたホスト名は、<route-name>。<route-namespace>。<domain> のパターンに従います。これは、入力のデフォルトのワイルドカードドメイン接尾辞としても使用されます。デフォルトの ingresscontroller ドメインは、*。<domain> のパターンに従います。一度設定すると、ドメインの変更は現在サポートされていません。 |
|
|
| requiredHSTSPolicies は、ポリシーで指定された domainPattern/s および namespaceSelector/s に一致する新しく作成または更新されたルートに設定する必要がある HSTS ポリシーを指定します。各 requiredHSTSPolicy には、ルート HSTS ポリシールートアノテーションを検証し、ルートアドミッションに影響を与えるために、少なくとも domainPattern と maxAge が必要です。HSTS ポリシールートアノテーションが付いている場合、候補ルートは HSTS ポリシーについてチェックされます: "haproxy.router.openshift.io/hsts_header" 例:haproxy.router.openshift.io/hsts_header:max-age = 31536000; preload; includeSubDomains-For 各候補ルートは、requiredHSTSPolicy domainPattern およびオプションの namespaceSelector と一致する場合、maxAge、preloadPolicy、および includeSubdomainsPolicy が許可されるために有効である必要があります。それ以外の場合、ルートは拒否されます。--domainPattern およびオプションの namespaceSelector による、RequiredHSTSPolicies の順序での最初の一致により、ルートのアドミッションステータスが決まります。- 候補ルートが requiredHSTSPolicy の HSTSPolicydomainPattern およびオプションの namespaceSelector と一致しない場合、HSTS ポリシーアノテーションを使用できます。HSTS ポリシー設定は、ルートがすでに作成された後で変更される場合があります。更新されたルートが更新された HSTS ポリシー設定に準拠していない場合、以前に許可されたルートへの更新は失敗する可能性があります。ただし、HSTS ポリシー設定を変更しても、すでに許可されているルートが機能しなくなることはありません。RequiredHSTSPolicies がない場合、ルート上のすべての HSTS ポリシーアノテーションが有効であることに注意してください。 |
|
|
|
8.14.1.2. .spec.componentRoutes リンクのコピーリンクがクリップボードにコピーされました!
- Description
- componentRoutes は、クラスター管理者がホスト名とサービング証明書を設定できる OpenShift コンポーネントによって管理されるルートのオプションのリストです。このリストの各ルートの名前空間と名前は、status.componentRoutes リストの既存のエントリーと一致する必要があります。設定可能なルートのセットを判別するには、.status.componentRoutes リストの名前空間とエントリーの名前を確認します。ここで、参加している Operator が設定可能なルートのステータスを書き込みます。
- タイプ
-
array
8.14.1.3. .spec.componentRoutes[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ComponentRouteSpec を使用すると、ルートのホスト名とサービング証明書を設定できます。
- タイプ
-
object - 必須
-
hostname -
name -
namespace
-
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| hostname は、ルートで使用されるホスト名です。 |
|
|
| name は、カスタマイズするルートの論理名です。ルートをカスタマイズする場合は、この componentRoute の名前空間と名前が status.componentRoutes のリストの対応するエントリーと一致する必要があります。 |
|
|
| namespace は、カスタマイズするルートの名前空間です。ルートをカスタマイズする場合は、この componentRoute の名前空間と名前が status.componentRoutes のリストの対応するエントリーと一致する必要があります。 |
|
|
|
ServingCertKeyPairSecret は、openshift-config 名前空間のタイプ |
8.14.1.4. .spec.componentRoutes[].servingCertKeyPairSecret リンクのコピーリンクがクリップボードにコピーされました!
- Description
-
ServingCertKeyPairSecret は、openshift-config 名前空間のタイプ
kubernetes.io/tlsのシークレットへの参照です。サービング証明書/キーのペアは一致する必要があり、この名前でサービングする目的を果たすために Operator によって使用されます。カスタムホスト名がクラスターのデフォルトのルーティング接尾辞を使用する場合、サービング証明書のシークレット指定は必要ありません。 - タイプ
-
object - 必須
-
name
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| name は、参照されるシークレットの metadata.name です。 |
8.14.1.5. .spec.requiredHSTSPolicies リンクのコピーリンクがクリップボードにコピーされました!
- Description
- requiredHSTSPolicies は、ポリシーで指定された domainPattern/s および namespaceSelector/s に一致する新しく作成または更新されたルートに設定する必要がある HSTS ポリシーを指定します。各 requiredHSTSPolicy には、ルート HSTS ポリシールートアノテーションを検証し、ルートアドミッションに影響を与えるために、少なくとも domainPattern と maxAge が必要です。HSTS ポリシールートアノテーションが付いている場合、候補ルートは HSTS ポリシーについてチェックされます: "haproxy.router.openshift.io/hsts_header" 例:haproxy.router.openshift.io/hsts_header:max-age = 31536000; preload; includeSubDomains-For 各候補ルートは、requiredHSTSPolicy domainPattern およびオプションの namespaceSelector と一致する場合、maxAge、preloadPolicy、および includeSubdomainsPolicy が許可されるために有効である必要があります。それ以外の場合、ルートは拒否されます。--domainPattern およびオプションの namespaceSelector による、RequiredHSTSPolicies の順序での最初の一致により、ルートのアドミッションステータスが決まります。- 候補ルートが requiredHSTSPolicy の HSTSPolicydomainPattern およびオプションの namespaceSelector と一致しない場合、HSTS ポリシーアノテーションを使用できます。HSTS ポリシー設定は、ルートがすでに作成された後で変更される場合があります。更新されたルートが更新された HSTS ポリシー設定に準拠していない場合、以前に許可されたルートへの更新は失敗する可能性があります。ただし、HSTS ポリシー設定を変更しても、すでに許可されているルートが機能しなくなることはありません。RequiredHSTSPolicies がない場合、ルート上のすべての HSTS ポリシーアノテーションが有効であることに注意してください。
- タイプ
-
array
8.14.1.6. .spec.requiredHSTSPolicies[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- タイプ
-
object - 必須
-
domainPatterns
-
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| domainPatterns は、必要な HSTS アノテーションが必要なドメインのリストです。domainPatterns が指定され、ドメインの 1 つと一致する spec.host を使用してルートが作成される場合、ルートは、一致する RequiredHSTSPolicy で説明されている HSTS ポリシーコンポーネントを指定する必要があります。ワイルドカードの使用は次のように許可され ます。.foo.com は foo.com の下のすべてに一致します。foo.com は foo.com とのみ一致するため、foo.com とその下のすべてをカバーするには、*both を指定する必要があります。 |
|
|
| includeSubDomainsPolicy は、HSTS ポリシーがホストのドメイン名のすべてのサブドメインに適用される必要があることを意味します。したがって、ホスト bar.foo.com の場合、includeSubDomainsPolicy が RequireIncludeSubDomains に設定されていると、次のようになります。- ホスト app.bar.foo.com は bar.foo.com の HSTS ポリシーを継承します - ホスト bar.foo.com は bar.foo.com の HSTS ポリシー - ホスト foo.com は bar.foo.com の HSTS ポリシーを継承しません - ホスト def.foo.com は bar.foo.com の HSTS ポリシーを継承しません |
|
|
| maxAge は、ホストが HSTS ホストと見なされる秒単位のデルタ時間範囲です。0 に設定すると、効果が無効になり、ホストは HSTS ホストとして削除されます。0 に設定し、includeSubdomains を指定すると、ホストのすべてのサブドメインも HSTS ホストとして削除されます。maxAge は存続時間の値であり、このポリシーがクライアントで更新されない場合、HSTS ポリシーは最終的にそのクライアントで期限切れになります。 |
|
|
| namespaceSelector は、ポリシーがセレクターと一致するラベルを持つ名前空間にあり、DomainPatterns の 1 つにあるルートにのみ適用されるようにラベルセレクターを指定します。デフォルトは空の LabelSelector で、すべてに一致します。 |
|
|
| preloadPolicy は、HSTS ヘッダーを取得するために初期ロードを実行する必要がないように、ホストをホストプリロードリストに含めるようにクライアントに指示します (これは RFC 6797 で定義されていないため、クライアントの実装に依存します)。 |
8.14.1.7. .spec.requiredHSTSPolicies[].maxAge リンクのコピーリンクがクリップボードにコピーされました!
- Description
- maxAge は、ホストが HSTS ホストと見なされる秒単位のデルタ時間範囲です。0 に設定すると、効果が無効になり、ホストは HSTS ホストとして削除されます。0 に設定し、includeSubdomains を指定すると、ホストのすべてのサブドメインも HSTS ホストとして削除されます。maxAge は存続時間の値であり、このポリシーがクライアントで更新されない場合、HSTS ポリシーは最終的にそのクライアントで期限切れになります。
- タイプ
-
object
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| RequiredHSTSPolicy max-age の最大許容値 (秒単位) この値は指定しないでおくことができます。その場合、上限は適用されません。 |
|
|
| RequiredHSTSPolicy max-age の最小許容値 (秒単位)max-age = 0 を設定すると、ホストから既存の HSTS ヘッダーを削除できます。これは、管理者が間違いをすばやく修正するために必要なツールです。この値は指定しないでおくことができます。その場合、下限は適用されません。 |
8.14.1.8. .spec.requiredHSTSPolicies[].namespaceSelector リンクのコピーリンクがクリップボードにコピーされました!
- Description
- namespaceSelector は、ポリシーがセレクターと一致するラベルを持つ名前空間にあり、DomainPatterns の 1 つにあるルートにのみ適用されるようにラベルセレクターを指定します。デフォルトは空の LabelSelector で、すべてに一致します。
- タイプ
-
object
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合されます。 |
|
|
| ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。 |
|
|
| matchLabels は、{key,value} ペアのマップです。MatchLabels マップの 1 つの {key,value} は matchExpressions の要素と同じで、キーフィールドには key、演算子には In、値配列には value のみが含まれます。要件は AND で結合されます。 |
8.14.1.9. .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions リンクのコピーリンクがクリップボードにコピーされました!
- Description
- matchExpressions はラベルセレクターの要件の一覧です。要件は AND で結合されます。
- タイプ
-
array
8.14.1.10. .spec.requiredHSTSPolicies[].namespaceSelector.matchExpressions[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ラベルセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
- タイプ
-
object - 必須
-
key -
operator
-
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| key は、セレクターの適用先のラベルキーです。 |
|
|
| operator はキーと値のセットの関係を表します。有効な演算子は In、NotIn、Exists、および DoesNotExist です。 |
|
|
| values は文字列値の配列です。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。 |
8.14.1.11. .status リンクのコピーリンクがクリップボードにコピーされました!
- Description
- status クラスターから監視される値を保持します。それらはオーバーライドされない場合があります。
- タイプ
-
object
| プロパティー | タイプ | Description |
|---|---|---|
|
|
| componentRoutes は、参加している Operator が、クラスター管理者がホスト名とサービング証明書をカスタマイズできるルートの現在のルートステータスを配置する場所です。 |
|
|
| ComponentRouteStatus には、ルートのホスト名とサービング証明書の設定を可能にする情報が含まれています。 |
8.14.1.12. .status.componentRoutes リンクのコピーリンクがクリップボードにコピーされました!
- Description
- componentRoutes は、参加している Operator が、クラスター管理者がホスト名とサービング証明書をカスタマイズできるルートの現在のルートステータスを配置する場所です。
- タイプ
-
array
8.14.1.13. .status.componentRoutes[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
- ComponentRouteStatus には、ルートのホスト名とサービング証明書の設定を可能にする情報が含まれています。
- タイプ
-
object - 必須
-
defaultHostname -
name -
namespace -
relatedObjects
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| 条件は、componentRoutes エントリーの状態を伝達するために使用されます。サポートされている条件には、Available、Degraded、および Progressing が含まれます。利用可能が true の場合、ルートによって提供されるコンテンツにユーザーがアクセスできます。これには、cluster-admin によって指定されたカスタマイズされたルートが設定されている間、デフォルトがコンテンツを提供し続ける場合が含まれます。Degraded が true の場合、componentRoutes エントリーを処理しようとして問題が発生したことを意味します。currentHostnames フィールドは、有効な場合と無効な場合があります。Progressing が true の場合、コンポーネントが componentRoutes エントリーに関連するアクションを実行していることを意味します。 |
|
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパス.status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded"//+ patchMergeKey = type//+ patchStrategy = merge//+ listType = map//+ listMapKey = type Conditions metav1.Condition |
|
|
| sumptionUsers は、servingCertKeyPairSecret シークレットの読み取り権限が必要な ServiceAccounts のスライスです。 |
|
|
| currentHostnames は、ルートで使用されている現在の名前のリストです。通常、このリストは単一のホスト名で設定されている必要がありますが、ルートで複数のホスト名がサポートされている場合、Operator はこのリストに複数のエントリーを書き込むことができます。 |
|
|
| defaultHostname は、カスタマイズ前のこのルートのホスト名です。 |
|
|
| name は、カスタマイズするルートの論理名です。ルートリソースの実際の名前である必要はありませんが、名前を変更することはできません。ルートをカスタマイズする場合、この componentRoute の名前空間と名前は、spec.componentRoutes のリスト内の対応するエントリーと一致する必要があります。 |
|
|
| namespace は、カスタマイズするルートの名前空間です。実際の名前空間である必要があります。実際の名前空間を使用すると、2 つのコンポーネントが競合することはなく、同じコンポーネントを複数回インストールできます。ルートをカスタマイズする場合、この componentRoute の名前空間と名前は、spec.componentRoutes のリスト内の対応するエントリーと一致する必要があります。 |
|
|
| relatedObjects は、spec.componentRoutes がどのように適用されるかをデバッグまたは検査するときに役立つリソースのリストです。 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
8.14.1.14. .status.componentRoutes[].conditions リンクのコピーリンクがクリップボードにコピーされました!
- Description
- 条件は、componentRoutes エントリーの状態を伝達するために使用されます。サポートされている条件には、Available、Degraded、および Progressing が含まれます。利用可能が true の場合、ルートによって提供されるコンテンツにユーザーがアクセスできます。これには、cluster-admin によって指定されたカスタマイズされたルートが設定されている間、デフォルトがコンテンツを提供し続ける場合が含まれます。Degraded が true の場合、componentRoutes エントリーを処理しようとして問題が発生したことを意味します。currentHostnames フィールドは、有効な場合と無効な場合があります。Progressing が true の場合、コンポーネントが componentRoutes エントリーに関連するアクションを実行していることを意味します。
- タイプ
-
array
8.14.1.15. .status.componentRoutes[].conditions[] リンクのコピーリンクがクリップボードにコピーされました!
- Description
-
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパス.status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{//foo の現在の状態の監視を表します。//既知の.status.conditions.type は次のとおりです: "Available"、"Progressing"、および "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition
json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"//その他のフィールド} - タイプ
-
object - 必須
-
lastTransitionTime -
message -
reason -
status -
type
-
| プロパティー | タイプ | 説明 |
|---|---|---|
|
|
| lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].gitopsdGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
8.14.2. API エンドポイント リンクのコピーリンクがクリップボードにコピーされました!
以下の API エンドポイントを利用できます。
/apis/config.openshift.io/v1/ingresses-
DELETE: 入力のコレクションを削除します -
GET:Ingress の種類のオブジェクトを一覧表示します -
POST: 入力を作成します
-
/apis/config.openshift.io/v1/ingresses/{name}-
削除: 入力を削除します -
GET: 指定された入力を読み取ります -
PATCH: 指定された入力を部分的に更新します -
PUT: 指定された入力を置き換えます
-
/apis/config.openshift.io/v1/ingresses/{name}/status-
GET: 指定された入力のステータスを読み取ります -
PATCH: 指定された入力のステータスを部分的に更新します -
PUT: 指定された入力のステータスを置き換えます
-
8.14.2.1. /apis/config.openshift.io/v1/ingresses リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE - Description
- Ingress のコレクションを削除します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - Description
- Ingress の種類のオブジェクトを一覧表示します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。 |
|
|
| サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。 watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。 |
|
|
| 返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。 |
|
|
| 返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。 |
|
|
| limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。 サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。 |
|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
|
| resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
|
|
| リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。 |
|
|
| 説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。 |
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - Description
- イングレスを作成する
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
8.14.2.2. /apis/config.openshift.io/v1/ingresses/{name} リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| イングレスの名前 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
DELETE - Description
- 入力を削除します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
|
| オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。 |
|
|
| 非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。 |
|
|
| ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - Description
- 指定された入力を読み取ります
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - Description
- 指定された入力を部分的に更新します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - Description
- 指定された入力を置き換えます
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
8.14.2.3. /apis/config.openshift.io/v1/ingresses/{name}/status リンクのコピーリンクがクリップボードにコピーされました!
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| イングレスの名前 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| 'true' の場合、出力はきれいに印刷されます。 |
- HTTP メソッド
-
GET - Description
- 指定された入力のステータスを読み取ります
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。 Defaults to unset |
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - Description
- 指定された入力のステータスを部分的に更新します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンス本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - Description
- 指定された入力のステータスを置き換えます
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。 |
|
|
| fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|