28.9. FlowCollector 設定パラメーター
FlowCollector は、基盤となるデプロイメントを操作および設定するネットワークフロー収集 API のスキーマです。
28.9.1. FlowCollector API 仕様
- 説明
-
FlowCollector
は、基盤となるデプロイメントを操作および設定するネットワークフロー収集 API のスキーマです。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーは、クライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。キャメルケースを使用します。詳細は、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 を参照してください。 |
|
|
|
28.9.1.1. .metadata
- 説明
- 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
- 型
-
object
28.9.1.2. .spec
- 説明
-
FlowCollectorSpec
は FlowCollector リソースの望ましい状態を定義します。
*: このドキュメントで "サポート対象外" または "非推奨" と記載されている場合、Red Hat はその機能を公式にサポートしていません。たとえば、コミュニティーによって提供され、メンテナンスに関する正式な合意なしに受け入れられた可能性があります。製品のメンテナーは、ベストエフォートに限定してこれらの機能に対するサポートを提供する場合があります。 - 型
-
object
- 必須
-
agent (エージェント)
-
deploymentModel
-
プロパティー | 型 | 説明 |
---|---|---|
|
| フローを展開するためのエージェント設定。 |
|
|
|
|
|
|
|
|
|
|
|
Kafka 設定。Kafka をフローコレクションパイプラインの一部としてブローカーとして使用できます。 |
|
| ロキ、フローストア、クライアント設定。 |
|
| NetObserv Pod がデプロイされる namespace。空の場合は、Operator の namespace が使用されます。 |
|
|
|
28.9.1.3. .spec.agent
- 説明
- フローを展開するためのエージェント設定。
- 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
28.9.1.4. .spec.agent.ebpf
- 説明
-
ebpf
は、spec.agent.type
がEBPF
に設定されている場合の eBPF ベースのフローレポーターに関連する設定を説明します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| eBPF Agent コンテナーの特権モード。一般に、この設定は無視するか、false に設定できます。その場合、オペレーターはコンテナーに詳細な機能 (BPF、PERFMON、NET_ADMIN、SYS_RESOURCE) を設定して、正しい操作を有効にします。CAP_BPF を認識しない古いカーネルバージョンが使用されている場合など、何らかの理由でこれらの機能を設定できない場合は、このモードをオンにして、より多くのグローバル権限を取得できます。 |
|
|
|
|
| フローレポーターのサンプリングレート。100 は、100 の 1 つのフローが送信されることを意味します。0 または 1 は、すべてのフローがサンプリングされることを意味します。 |
28.9.1.5. .spec.agent.ebpf.debug
- 説明
-
debug
では、eBPF エージェントの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと、GOGC や GOMAXPROCS 環境変数などのきめ細かいパフォーマンスの最適化のみを目的としています。その値を設定するユーザーは、自己責任で行ってください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
28.9.1.6. .spec.agent.ebpf.resources
- 説明
-
resources
は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 制限は、許容されるコンピュートリソースの最大量を記述します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| 要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細については、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
28.9.1.7. .spec.agent.ipfix
- 説明
-
ipfix
- 非推奨 (*) -spec.agent.type
がIPFIX
に設定されている場合の IPFIX ベースのフローレポーターに関連する設定について説明します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
28.9.1.8. .spec.agent.ipfix.clusterNetworkOperator
- 説明
-
clusterNetworkOperator
は、利用可能な場合、OpenShift Container Platform Cluster Network Operator に関連する設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| ConfigMap がデプロイされる namespace。 |
28.9.1.9. .spec.agent.ipfix.ovnKubernetes
- 説明
-
ovnKubernetes
は、利用可能な場合、OVN-Kubernetes CNI の設定を定義します。この設定は、OpenShift Container Platform なしで OVN の IPFIX エクスポートを使用する場合に使用されます。OpenShift Container Platform を使用する場合は、代わりにclusterNetworkOperator
プロパティーを参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| OVN-Kubernetes Pod がデプロイされる namespace。 |
28.9.1.10. .spec.consolePlugin
- 説明
-
consolePlugin
は、利用可能な場合、OpenShift Container Platform コンソールプラグインに関連する設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
プラグインのデプロイメント用に設定する水平 Pod オートスケーラーの |
|
|
|
|
|
コンソールプラグインバックエンドの |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
28.9.1.11. .spec.consolePlugin.autoscaler
- 説明
-
プラグインのデプロイメント用に設定する水平 Pod オートスケーラーの
autoscaler
仕様。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。 - 型
-
object
28.9.1.12. .spec.consolePlugin.portNaming
- 説明
-
portNaming
は、ポートからサービス名への変換の設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| コンソールプラグインのポートからサービス名への変換を有効にします。 |
|
|
|
28.9.1.13. .spec.consolePlugin.quickFilters
- 説明
-
quickFilters
は、コンソールプラグインのクイックフィルタープリセットを設定します。 - 型
-
array
28.9.1.14. .spec.consolePlugin.quickFilters[]
- 説明
-
QuickFilter
は、コンソールのクイックフィルターのプリセット設定を定義します。 - 型
-
object
- 必須
-
filter
-
name
-
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| コンソールに表示されるフィルターの名前 |
28.9.1.15. .spec.consolePlugin.resources
- 説明
-
resources
(コンピューティングリソースから見た場合にコンテナーに必要)。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 制限は、許容されるコンピュートリソースの最大量を記述します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| 要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
28.9.1.16. .spec.exporters
- 説明
-
exporters
は、カスタム消費またはストレージ用の追加のオプションのエクスポータを定義します。 - 型
-
array
28.9.1.17. .spec.exporters[]
- 説明
-
FlowCollectorExporter
は、強化されたフローを送信する追加のエクスポーターを定義します。 - 型
-
object
- 必須
-
type
-
プロパティー | 型 | 説明 |
---|---|---|
|
| 強化された IPFIX フローの送信先となる、IP アドレスやポートなどの IPFIX 設定。サポート対象外 (*)。 |
|
| 強化されたフローの送信先となる、アドレスやトピックなどの Kafka 設定。 |
|
|
|
28.9.1.18. .spec.exporters[].ipfix
- 説明
- 強化された IPFIX フローの送信先となる、IP アドレスやポートなどの IPFIX 設定。サポート対象外 (*)。
- 型
-
object
- 必須
-
targetHost
-
targetPort
-
プロパティー | 型 | 説明 |
---|---|---|
|
| IPFIX 外部レシーバーのアドレス |
|
| IPFIX 外部レシーバー用のポート |
|
|
IPFIX 接続に使用されるトランスポートプロトコル ( |
28.9.1.19. .spec.exporters[].kafka
- 説明
- 強化されたフローの送信先となる、アドレスやトピックなどの Kafka 設定。
- 型
-
object
- 必須
-
address
-
topic
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Kafka サーバーのアドレス |
|
|
TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。eBPF エージェントを使用する場合は、Kafka 証明書をエージェント namespace にコピーする必要があることに注意してください (デフォルトは |
|
| 使用する Kafka トピック。存在する必要があり、NetObserv はそれを作成しません。 |
28.9.1.20. .spec.exporters[].kafka.tls
- 説明
-
TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。eBPF エージェントを使用する場合は、Kafka 証明書をエージェント namespace にコピーする必要があることに注意してください (デフォルトは
netobserv-privileged
)。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
28.9.1.21. .spec.exporters[].kafka.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.22. .spec.exporters[].kafka.tls.userCert
- 説明
-
userCert
は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.23. .spec.kafka
- 説明
-
Kafka 設定。Kafka をフローコレクションパイプラインの一部としてブローカーとして使用できます。
spec.deploymentModel
がKAFKA
の場合に利用できます。 - 型
-
object
- 必須
-
address
-
topic
-
プロパティー | 型 | 説明 |
---|---|---|
|
| Kafka サーバーのアドレス |
|
|
TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。eBPF エージェントを使用する場合は、Kafka 証明書をエージェント namespace にコピーする必要があることに注意してください (デフォルトは |
|
| 使用する Kafka トピック。存在する必要があり、NetObserv はそれを作成しません。 |
28.9.1.24. .spec.kafka.tls
- 説明
-
TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。eBPF エージェントを使用する場合は、Kafka 証明書をエージェント namespace にコピーする必要があることに注意してください (デフォルトは
netobserv-privileged
)。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
28.9.1.25. .spec.kafka.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.26. .spec.kafka.tls.userCert
- 説明
-
userCert
は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.27. .spec.loki
- 説明
- ロキ、フローストア、クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Loki ステータス URL の TLS クライアント設定。 |
|
|
|
|
|
|
|
|
|
|
| Loki URL の TLS クライアント設定。 |
|
|
|
28.9.1.28. .spec.loki.statusTls
- 説明
- Loki ステータス URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
28.9.1.29. .spec.loki.statusTls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.30. .spec.loki.statusTls.userCert
- 説明
-
userCert
は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.31. .spec.loki.tls
- 説明
- Loki URL の TLS クライアント設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
| TLS を有効にします。 |
|
|
|
|
|
|
28.9.1.32. .spec.loki.tls.caCert
- 説明
-
caCert
は、認証局の証明書の参照を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.33. .spec.loki.tls.userCert
- 説明
-
userCert
は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.34. .spec.processor
- 説明
-
processor
は、エージェントからフローを受信し、それを強化し、メトリクスを生成し、 Loki 永続化レイヤーや使用可能なエエクスポーターに転送するコンポーネントの設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
プロセッサーランタイムの |
|
|
|
|
|
|
|
| フローコレクターのポート (ホストポート)。慣例により、一部の値は禁止されています。1024 より大きい値とし、4500、4789、6081 は使用できません。 |
|
|
|
|
|
|
28.9.1.35. .spec.processor.debug
- 説明
-
debug
では、フロープロセッサーの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと、GOGC や GOMAXPROCS 環境変数などのきめ細かいパフォーマンスの最適化のみを目的としています。その値を設定するユーザーは、自己責任で行ってください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
28.9.1.36. .spec.processor.kafkaConsumerAutoscaler
- 説明
-
kafkaConsumerAutoscaler
は、Kafka メッセージを消費するflowlogs-pipeline-transformer
を設定する水平 Pod オートスケーラーの仕様です。Kafka が無効になっている場合、この設定は無視されます。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。 - 型
-
object
28.9.1.37. .spec.processor.metrics
- 説明
-
Metric
は、メトリクスに関するプロセッサー設定を定義します。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| Prometheus スクレイパーの metricsServer エンドポイント設定 |
28.9.1.38. .spec.processor.metrics.server
- 説明
- Prometheus スクレイパーの metricsServer エンドポイント設定
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| Prometheus HTTP ポート |
|
| TLS 設定。 |
28.9.1.39. .spec.processor.metrics.server.tls
- 説明
- TLS 設定。
- 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
TLS 設定のタイプを選択します。 |
28.9.1.40. .spec.processor.metrics.server.tls.provided
- 説明
-
type
がPROVIDED
に設定されている場合の TLS 設定。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
|
|
|
|
|
|
| 証明書を含む config map またはシークレットの名前 |
|
| 証明書を含む config map またはシークレットの namespace省略した場合、NetObserv がデプロイされている場所と同じ namespace が想定されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。 |
|
|
証明書参照のタイプ: |
28.9.1.41. .spec.processor.resources
- 説明
-
resources
は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 - 型
-
object
プロパティー | 型 | 説明 |
---|---|---|
|
| 制限は、許容されるコンピュートリソースの最大量を記述します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |
|
| 要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。 |