第13章 FlowCollector API リファレンス
FlowCollector は、基盤となるデプロイメントを操作および設定するネットワークフロー収集 API のスキーマです。
13.1. FlowCollector API 仕様
- 説明
-
FlowCollector
は、基盤となるデプロイメントを操作および設定するネットワークフロー収集 API のスキーマです。 - 型
-
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 を参照してください。 |
|
|
FlowCollector リソースの望ましい状態を定義します。 *: このドキュメントで「サポート対象外」または「非推奨」と記載されている場合、Red Hat はその機能を公式にサポートしていません。たとえば、コミュニティーによって提供され、メンテナンスに関する正式な合意なしに受け入れられた可能性があります。製品のメンテナーは、ベストエフォートに限定してこれらの機能に対するサポートを提供する場合があります。 |
13.1.1. .metadata
- 説明
- 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
- 型
-
object
13.1.2. .spec
- 説明
FlowCollector リソースの望ましい状態を定義します。
*: このドキュメントで「サポート対象外」または「非推奨」と記載されている場合、Red Hat はその機能を公式にサポートしていません。たとえば、コミュニティーによって提供され、メンテナンスに関する正式な合意なしに受け入れられた可能性があります。製品のメンテナーは、ベストエフォートに限定してこれらの機能に対するサポートを提供する場合があります。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| フローを抽出するためのエージェント設定。 |
|
|
|
|
|
-
- Kafka は、より優れたスケーラビリティ、回復性、および高可用性を提供できます (詳細は、https://www.redhat.com/en/topics/integration/what-is-apache-kafka を参照してください)。 |
|
|
|
|
|
Kafka 設定。Kafka をフローコレクションパイプラインの一部としてブローカーとして使用できます。この設定を利用できるのは、 |
|
|
|
|
| Network Observability Pod がデプロイされる namespace。 |
|
|
|
|
|
|
|
|
|
13.1.3. .spec.agent
- 説明
- フローを抽出するためのエージェント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
13.1.4. .spec.agent.ebpf
- 説明
-
ebpf
は、spec.agent.type
がeBPF
に設定されている場合、eBPF ベースのフローレポーターに関連する設定を示します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
有効にする追加機能のリスト。これらはデフォルトですべて無効になっています。追加機能を有効にすると、パフォーマンスに影響が出る可能性があります。可能な値は次のとおりです。
-
-
-
- |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
eBPF Agent コンテナーの特権モード。無視されるか |
|
|
|
|
| フローレポーターのサンプリングレート。100 は、100 の 1 つのフローが送信されることを意味します。0 または 1 は、すべてのフローがサンプリングされることを意味します。 |
13.1.5. .spec.agent.ebpf.advanced
- 説明
-
advanced
を使用すると、eBPF エージェントの内部設定のいくつかの側面を設定できます。このセクションは、GOGC
やGOMAXPROCS
環境変数などのデバッグと詳細なパフォーマンスの最適化を主な目的としています。これらの値はお客様の責任のもと設定してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。 |
13.1.6. .spec.agent.ebpf.advanced.scheduling
- 説明
- scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。 |
|
|
|
|
| 指定した場合、Pod の優先度を示します。ドキュメントについては、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#how-to-use-priority-and-preemption を参照してください。指定されていない場合はデフォルトの優先度が使用され、デフォルトの優先度がない場合は 0 が使用されます。 |
|
|
|
13.1.7. .spec.agent.ebpf.advanced.scheduling.affinity
- 説明
- 指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。
- 型
-
object
13.1.8. .spec.agent.ebpf.advanced.scheduling.tolerations
- 説明
-
tolerations
は、一致する taint を持つノードに Pod がスケジュールできるようにする toleration のリストです。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。 - 型
-
array
13.1.9. .spec.agent.ebpf.flowFilter
- 説明
-
flowFilter
は、フローフィルタリングに関する eBPF エージェント設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
eBPF フローのフィルタリング機能を有効にするには、 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13.1.10. .spec.agent.ebpf.metrics
- 説明
-
metrics
は、メトリクスに関する eBPF エージェント設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
eBPF エージェントのメトリクス収集を無効にするには、 |
|
| Prometheus スクレイパーのメトリクスサーバーエンドポイント設定。 |
13.1.11. .spec.agent.ebpf.metrics.server
- 説明
- Prometheus スクレイパーのメトリクスサーバーエンドポイント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| メトリクスサーバーの HTTP ポート。 |
|
| TLS 設定。 |
13.1.12. .spec.agent.ebpf.metrics.server.tls
- 説明
- TLS 設定。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
TLS 設定のタイプを選択します。
- |
13.1.13. .spec.agent.ebpf.metrics.server.tls.provided
- 説明
-
type
がProvided
に設定されている場合の TLS 設定。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.14. .spec.agent.ebpf.metrics.server.tls.providedCaFile
- 説明
-
type
がProvided
に設定されている場合の CA ファイルへの参照。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| config map またはシークレット内のファイル名。 |
|
| ファイルを含む config map またはシークレットの名前。 |
|
| ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
ファイル参照のタイプ ( |
13.1.15. .spec.agent.ebpf.resources
- 説明
-
resources
は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
13.1.16. .spec.consolePlugin
- 説明
-
consolePlugin
は、利用可能な場合、OpenShift Container Platform コンソールプラグインに関連する設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
プラグインのデプロイメント用に設定する水平 Pod オートスケーラーの |
|
| コンソールプラグインのデプロイメントを有効にします。 |
|
|
|
|
|
コンソールプラグインバックエンドの |
|
|
|
|
|
|
|
|
|
|
|
|
13.1.17. .spec.consolePlugin.advanced
- 説明
-
advanced
を使用すると、コンソールプラグインの内部設定のいくつかの側面を設定できます。このセクションは、GOGC
やGOMAXPROCS
環境変数などのデバッグと詳細なパフォーマンスの最適化を主な目的としています。これらの値はお客様の責任のもと設定してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13.1.18. .spec.consolePlugin.advanced.scheduling
- 説明
-
scheduling
は、Pod がノードでどのようにスケジュールされるかを制御します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。 |
|
|
|
|
| 指定した場合、Pod の優先度を示します。ドキュメントについては、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#how-to-use-priority-and-preemption を参照してください。指定されていない場合はデフォルトの優先度が使用され、デフォルトの優先度がない場合は 0 が使用されます。 |
|
|
|
13.1.19. .spec.consolePlugin.advanced.scheduling.affinity
- 説明
- 指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。
- 型
-
object
13.1.20. .spec.consolePlugin.advanced.scheduling.tolerations
- 説明
-
tolerations
は、一致する taint を持つノードに Pod がスケジュールできるようにする toleration のリストです。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。 - 型
-
array
13.1.21. .spec.consolePlugin.autoscaler
- 説明
-
プラグインのデプロイメント用に設定する水平 Pod オートスケーラーの
autoscaler
仕様。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。 - 型
-
object
13.1.22. .spec.consolePlugin.portNaming
- 説明
-
portNaming
は、ポートからサービス名への変換の設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コンソールプラグインのポートからサービス名への変換を有効にします。 |
|
|
|
13.1.23. .spec.consolePlugin.quickFilters
- 説明
-
quickFilters
は、コンソールプラグインのクイックフィルタープリセットを設定します。 - 型
-
array
13.1.24. .spec.consolePlugin.quickFilters[]
- 説明
-
QuickFilter
は、コンソールのクイックフィルターのプリセット設定を定義します。 - 型
-
object
- 必須
-
filter
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| コンソールに表示されるフィルターの名前 |
13.1.25. .spec.consolePlugin.resources
- 説明
-
resources
(コンピューティングリソースから見た場合にコンテナーに必要)。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
13.1.26. .spec.exporters
- 説明
-
exporters
は、カスタム消費またはストレージ用の追加のオプションのエクスポータを定義します。 - 型
-
array
13.1.27. .spec.exporters[]
- 説明
-
FlowCollectorExporter
は、エンリッチされたフローを送信する追加のエクスポーターを定義します。 - 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| エンリッチされた IPFIX フローの送信先の IP アドレスやポートなどの IPFIX 設定。 |
|
| エンリッチされたフローの送信先のアドレスやトピックなどの Kafka 設定。 |
|
| エンリッチされたログやメトリクスの送信先の IP アドレスやポートなどの OpenTelemetry 設定。 |
|
|
|
13.1.28. .spec.exporters[].ipfix
- 説明
- エンリッチされた IPFIX フローの送信先の IP アドレスやポートなどの IPFIX 設定。
- 型
-
object
- 必須
-
targetHost
-
targetPort
-
プロパティー | 型 | 説明 |
---|---|---|
|
| IPFIX 外部レシーバーのアドレス。 |
|
| IPFIX 外部レシーバー用のポート。 |
|
|
IPFIX 接続に使用されるトランスポートプロトコル ( |
13.1.29. .spec.exporters[].kafka
- 説明
- エンリッチされたフローの送信先のアドレスやトピックなどの Kafka 設定。
- 型
-
object
- 必須
-
address
-
topic
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Kafka サーバーのアドレス |
|
| SASL 認証の設定。[サポート対象外 (*)]。 |
|
| TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。 |
|
| 使用する Kafka トピック。これは必ず存在する必要があります。Network Observability はこれを作成しません。 |
13.1.30. .spec.exporters[].kafka.sasl
- 説明
- SASL 認証の設定。[サポート対象外 (*)]。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| クライアント ID を含むシークレットまたは config map への参照 |
|
| クライアントシークレットを含むシークレットまたは config map への参照 |
|
|
使用する SASL 認証のタイプ。SASL を使用しない場合は |
13.1.31. .spec.exporters[].kafka.sasl.clientIDReference
- 説明
- クライアント ID を含むシークレットまたは config map への参照
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| config map またはシークレット内のファイル名。 |
|
| ファイルを含む config map またはシークレットの名前。 |
|
| ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
ファイル参照のタイプ ( |
13.1.32. .spec.exporters[].kafka.sasl.clientSecretReference
- 説明
- クライアントシークレットを含むシークレットまたは config map への参照
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| config map またはシークレット内のファイル名。 |
|
| ファイルを含む config map またはシークレットの名前。 |
|
| ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
ファイル参照のタイプ ( |
13.1.33. .spec.exporters[].kafka.tls
- 説明
- TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.34. .spec.exporters[].kafka.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.35. .spec.exporters[].kafka.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.36. .spec.exporters[].openTelemetry
- 説明
- エンリッチされたログやメトリクスの送信先の IP アドレスやポートなどの OpenTelemetry 設定。
- 型
-
object
- 必須
-
targetHost
-
targetPort
-
プロパティー | 型 | 説明 |
---|---|---|
|
| OpenTelemetry 準拠の形式にマッピングされるカスタムフィールド。デフォルトでは、Network Observability の形式の提案 (https://github.com/rhobs/observability-data-model/blob/main/network-observability.md#format-proposal) が使用されます。L3 または L4 エンリッチ化ネットワークログについては、現在、受け入れられている標準が存在しないため、デフォルトを独自の形式で自由にオーバーライドできます。 |
|
| メッセージに追加するヘッダー (任意)。 |
|
| ログの OpenTelemetry 設定。 |
|
| メトリクスの OpenTelemetry 設定。 |
|
|
OpenTelemetry 接続のプロトコル。使用可能なオプションは |
|
| OpenTelemetry レシーバーのアドレス。 |
|
| OpenTelemetry レシーバーのポート。 |
|
| TLS クライアント設定。 |
13.1.37. .spec.exporters[].openTelemetry.fieldsMapping
- 説明
- OpenTelemetry 準拠の形式にマッピングされるカスタムフィールド。デフォルトでは、Network Observability の形式の提案 (https://github.com/rhobs/observability-data-model/blob/main/network-observability.md#format-proposal) が使用されます。L3 または L4 エンリッチ化ネットワークログについては、現在、受け入れられている標準が存在しないため、デフォルトを独自の形式で自由にオーバーライドできます。
- 型
-
array
13.1.38. .spec.exporters[].openTelemetry.fieldsMapping[]
- 説明
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| |
|
| |
|
|
13.1.39. .spec.exporters[].openTelemetry.logs
- 説明
- ログの OpenTelemetry 設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
ログを OpenTelemetry レシーバーに送信するには、 |
13.1.40. .spec.exporters[].openTelemetry.metrics
- 説明
- メトリクスの OpenTelemetry 設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
メトリクスを OpenTelemetry レシーバーに送信するには、 |
|
| メトリクスをコレクターに送信する頻度を指定します。 |
13.1.41. .spec.exporters[].openTelemetry.tls
- 説明
- TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.42. .spec.exporters[].openTelemetry.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.43. .spec.exporters[].openTelemetry.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.44. .spec.kafka
- 説明
-
Kafka 設定。Kafka をフローコレクションパイプラインの一部としてブローカーとして使用できます。この設定を利用できるのは、
spec.deploymentModel
がKafka
の場合です。 - 型
-
object
- 必須
-
address
-
topic
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Kafka サーバーのアドレス |
|
| SASL 認証の設定。[サポート対象外 (*)]。 |
|
| TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。 |
|
| 使用する Kafka トピック。これは必ず存在する必要があります。Network Observability はこれを作成しません。 |
13.1.45. .spec.kafka.sasl
- 説明
- SASL 認証の設定。[サポート対象外 (*)]。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| クライアント ID を含むシークレットまたは config map への参照 |
|
| クライアントシークレットを含むシークレットまたは config map への参照 |
|
|
使用する SASL 認証のタイプ。SASL を使用しない場合は |
13.1.46. .spec.kafka.sasl.clientIDReference
- 説明
- クライアント ID を含むシークレットまたは config map への参照
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| config map またはシークレット内のファイル名。 |
|
| ファイルを含む config map またはシークレットの名前。 |
|
| ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
ファイル参照のタイプ ( |
13.1.47. .spec.kafka.sasl.clientSecretReference
- 説明
- クライアントシークレットを含むシークレットまたは config map への参照
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| config map またはシークレット内のファイル名。 |
|
| ファイルを含む config map またはシークレットの名前。 |
|
| ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
ファイル参照のタイプ ( |
13.1.48. .spec.kafka.tls
- 説明
- TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.49. .spec.kafka.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.50. .spec.kafka.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.51. .spec.loki
- 説明
-
loki
(フローストア) のクライアント設定。 - 型
-
object
- 必須
-
mode
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
Loki にフローを保存するには、 |
|
|
|
|
|
|
|
|
|
|
|
- Loki が Loki Operator を使用して管理されている場合は、
- Loki がモノリシックなワークロードとしてインストールされている場合は、
- Loki がマイクロサービスとしてインストールされているが、Loki Operator がない場合は、
- 上記のオプションが、いずれもお使いの構成に合わない場合は、 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
13.1.52. .spec.loki.advanced
- 説明
-
advanced
を使用すると、Loki クライアントの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと詳細なパフォーマンスの最適化を主な目的としています。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
13.1.53. .spec.loki.lokiStack
- 説明
-
LokiStack
モードの Loki 設定。これは、Loki Operator を簡単に設定するのに役立ちます。他のモードでは無視されます。 - 型
-
object
- 必須
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 使用する既存の LokiStack リソースの名前。 |
|
|
この |
13.1.54. .spec.loki.manual
- 説明
-
Manual
モードの Loki 設定。これは最も柔軟な設定です。他のモードでは無視されます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
-
-
-
Loki Operator を使用する場合、 |
|
|
|
|
|
|
|
| Loki ステータス URL の TLS クライアント設定。 |
|
|
|
|
|
|
|
| Loki URL の TLS クライアント設定。 |
13.1.55. .spec.loki.manual.statusTls
- 説明
- Loki ステータス URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.56. .spec.loki.manual.statusTls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.57. .spec.loki.manual.statusTls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.58. .spec.loki.manual.tls
- 説明
- Loki URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.59. .spec.loki.manual.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.60. .spec.loki.manual.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.61. .spec.loki.microservices
- 説明
-
Microservices
モードの Loki 設定。このオプションは、Loki がマイクロサービスデプロイメントモード (https://grafana.com/docs/loki/latest/fundamentals/architecture/deployment-modes/#microservices-mode) を使用してインストールされている場合に使用します。他のモードでは無視されます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
| Loki URL の TLS クライアント設定。 |
13.1.62. .spec.loki.microservices.tls
- 説明
- Loki URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.63. .spec.loki.microservices.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.64. .spec.loki.microservices.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.65. .spec.loki.monolithic
- 説明
-
Monolithic
モードの Loki 設定。このオプションは、Loki がモノリシックデプロイメントモード (https://grafana.com/docs/loki/latest/fundamentals/architecture/deployment-modes/#monolithic-mode) を使用してインストールされている場合に使用します。他のモードでは無視されます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| Loki URL の TLS クライアント設定。 |
|
|
|
13.1.66. .spec.loki.monolithic.tls
- 説明
- Loki URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.67. .spec.loki.monolithic.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.68. .spec.loki.monolithic.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.69. .spec.networkPolicy
- 説明
-
networkPolicy
は、Network Observability のコンポーネントを分離するための Ingress ネットワークポリシー設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
Network Observability で使用される (メインおよび特権付きの) namespace にネットワークポリシーをデプロイするには、 |
13.1.70. .spec.processor
- 説明
-
processor
は、エージェントからフローを受信してエンリッチし、メトリクスを生成して Loki 永続化レイヤーや利用可能なエクスポーターに転送するコンポーネントの設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
プロセッサーランタイムの |
|
|
-
-
-
- |
|
|
|
|
|
マルチクラスター機能を有効にするには、 |
|
|
|
|
|
|
13.1.71. .spec.processor.advanced
- 説明
-
advanced
を使用すると、フロープロセッサーの内部設定のいくつかの側面を設定できます。このセクションは、GOGC
やGOMAXPROCS
環境変数などのデバッグと詳細なパフォーマンスの最適化を主な目的としています。これらの値はお客様の責任のもと設定してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| フローコレクターのポート (ホストポート)。慣例により、一部の値は禁止されています。1024 より大きい値とし、4500、4789、6081 は使用できません。 |
|
|
|
|
| scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。 |
|
| リソース識別のためにチェックするセカンダリーネットワークを定義します。正確な識別を確実に行うために、インデックス値からクラスター全体で一意の識別子が形成されるようにする必要があります。同じインデックスが複数のリソースで使用されている場合、それらのリソースに誤ったラベルが付けられる可能性があります。 |
13.1.72. .spec.processor.advanced.scheduling
- 説明
- scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。 |
|
|
|
|
| 指定した場合、Pod の優先度を示します。ドキュメントについては、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#how-to-use-priority-and-preemption を参照してください。指定されていない場合はデフォルトの優先度が使用され、デフォルトの優先度がない場合は 0 が使用されます。 |
|
|
|
13.1.73. .spec.processor.advanced.scheduling.affinity
- 説明
- 指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。
- 型
-
object
13.1.74. .spec.processor.advanced.scheduling.tolerations
- 説明
-
tolerations
は、一致する taint を持つノードに Pod がスケジュールできるようにする toleration のリストです。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。 - 型
-
array
13.1.75. .spec.processor.advanced.secondaryNetworks
- 説明
- リソース識別のためにチェックするセカンダリーネットワークを定義します。正確な識別を確実に行うために、インデックス値からクラスター全体で一意の識別子が形成されるようにする必要があります。同じインデックスが複数のリソースで使用されている場合、それらのリソースに誤ったラベルが付けられる可能性があります。
- 型
-
array
13.1.76. .spec.processor.advanced.secondaryNetworks[]
- 説明
- 型
-
object
- 必須
-
index
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
13.1.77. .spec.processor.kafkaConsumerAutoscaler
- 説明
-
kafkaConsumerAutoscaler
は、Kafka メッセージを消費するflowlogs-pipeline-transformer
を設定する水平 Pod オートスケーラーの仕様です。Kafka が無効になっている場合、この設定は無視されます。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。 - 型
-
object
13.1.78. .spec.processor.metrics
- 説明
-
Metric
は、メトリクスに関するプロセッサー設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| Prometheus スクレイパーのメトリクスサーバーエンドポイント設定 |
13.1.79. .spec.processor.metrics.server
- 説明
- Prometheus スクレイパーのメトリクスサーバーエンドポイント設定
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| メトリクスサーバーの HTTP ポート。 |
|
| TLS 設定。 |
13.1.80. .spec.processor.metrics.server.tls
- 説明
- TLS 設定。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
TLS 設定のタイプを選択します。
- |
13.1.81. .spec.processor.metrics.server.tls.provided
- 説明
-
type
がProvided
に設定されている場合の TLS 設定。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.82. .spec.processor.metrics.server.tls.providedCaFile
- 説明
-
type
がProvided
に設定されている場合の CA ファイルへの参照。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| config map またはシークレット内のファイル名。 |
|
| ファイルを含む config map またはシークレットの名前。 |
|
| ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
ファイル参照のタイプ ( |
13.1.83. .spec.processor.resources
- 説明
-
resources
は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| limits は、許可されるコンピュートリソースの最大量を示します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| requests は、必要なコンピュートリソースの最小量を示します。コンテナーで Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
13.1.84. .spec.processor.subnetLabels
- 説明
-
subnetLabels
を使用すると、サブネットと IP にカスタムラベルを定義したり、OpenShift Container Platform で認識されているサブネットの自動ラベル付けを有効にしたりできます。自動ラベル付けは、クラスターの外部トラフィックを識別するために使用されます。サブネットがフローの送信元 IP または宛先 IP と一致する場合、対応するフィールドSrcSubnetLabel
またはDstSubnetLabel
が追加されます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
13.1.85. .spec.processor.subnetLabels.customLabels
- 説明
-
customLabels
を使用すると、クラスター外部のワークロードや Web サービスの識別などのために、サブネットと IP のラベル付けをカスタマイズできます。openShiftAutoDetect
を有効にすると、検出されたサブネットがオーバーラップしている場合に、customLabels
がそのサブネットをオーバーライドできます。 - 型
-
array
13.1.86. .spec.processor.subnetLabels.customLabels[]
- 説明
- SubnetLabel を使用すると、クラスター外部のワークロードや Web サービスの識別などのために、サブネットと IP にラベルを付けることができます。
- 型
-
object
- 必須
-
cidrs
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| 一致するフローにフラグを設定するために使用するラベル名。 |
13.1.87. .spec.prometheus
- 説明
-
prometheus
は、コンソールプラグインからメトリクスを取得するために使用されるクエリー設定などの Prometheus 設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コンソールプラグインで使用される、クライアント設定などの Prometheus クエリー設定。 |
13.1.88. .spec.prometheus.querier
- 説明
- コンソールプラグインで使用される、クライアント設定などの Prometheus クエリー設定。
- 型
-
object
- 必須
-
mode
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
- 自動設定を試行するには、
- 手動設定の場合は、 |
|
|
|
13.1.89. .spec.prometheus.querier.manual
- 説明
-
Manual
モードの Prometheus 設定。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
ログインしたユーザートークンをクエリーで Prometheus に転送するには、 |
|
| Prometheus URL の TLS クライアント設定。 |
|
|
|
13.1.90. .spec.prometheus.querier.manual.tls
- 説明
- Prometheus URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
13.1.91. .spec.prometheus.querier.manual.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |
13.1.92. .spec.prometheus.querier.manual.tls.userCert
- 説明
-
userCert
は、ユーザー証明書の参照を定義し、mTLS に使用されます。一方向 TLS を使用する場合は、このプロパティーを無視できます。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前。 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、Network Observability がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ ( |