第 9 章 FlowCollector 配置参数
FlowCollector 是网络流集合 API 的 Schema,它试用并配置底层部署。
9.1. FlowCollector API 规格
- 描述
-
FlowCollector
是网络流集合 API 的 schema,它试用并配置底层部署。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: 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 资源所需状态。 |
9.1.1. .metadata
- 描述
- 标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- 类型
-
object
9.1.2. .spec
- 描述
-
定义 FlowCollector 资源所需状态。
*:在本文档中声明的"不支持"或"弃用"的功能代表红帽不正式支持这些功能。例如,这些功能可能由社区提供,并在没有正式维护协议的情况下被接受。产品维护人员可能只为这些功能提供一些支持。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 流提取的代理配置。 |
|
|
|
|
|
|
|
|
|
|
|
Kafka 配置,允许使用 Kafka 作为流集合管道的一部分。当 |
|
| Loki,流存储、客户端设置。 |
|
| 部署 Network Observability pod 的命名空间。 |
|
|
|
9.1.3. .spec.agent
- 描述
- 流提取的代理配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
|
|
9.1.4. .spec.agent.ebpf
- 描述
-
ebpf
描述了当spec.agent.type
设置为EBPF
时,与基于 eBPF 的流报告程序相关的设置。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
要启用的额外功能列表。它们都默认禁用。启用其他功能可能会对性能有影响。可能的值有: |
|
|
|
|
|
|
|
|
|
|
|
|
|
| eBPF Agent 容器的特权模式。通常,此设置可以忽略或设置为 false :在这种情况下,Operator 会将粒度功能(BPF、PERFMON、NET_ADMIN、SYS_RESOURCE)设置为容器,以启用其正确的操作。如果出于某种原因而无法设置这些功能,例如,如果旧的内核版本不知道 CAP_BPF,那么您可以打开此模式以获取更多全局权限。 |
|
|
|
|
| 流报告器的抽样率。100 表示发送 100 个流中的一个。0 或 1 表示所有流都是抽样的。 |
9.1.5. .spec.agent.ebpf.debug
- 描述
-
debug
允许设置 eBPF 代理的内部配置的一些方面。本节专门用于调试和精细的性能优化,如 GOGC 和 GOMAXPROCS env vars。用户设置其值会自行承担任何风险。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
9.1.6. .spec.agent.ebpf.resources
- 描述
-
resources
是此容器所需的计算资源。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.7. .spec.agent.ipfix
- 描述
-
ipfix
[deprecated (*)] - 当spec.agent.type
设置为 IPFIX 时,描述了与基于IPFIX
的流报告程序相关的设置。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9.1.8. .spec.agent.ipfix.clusterNetworkOperator
- 描述
-
clusterNetworkOperator
定义与 OpenShift Container Platform Cluster Network Operator 相关的设置(如果可用)。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 部署配置映射的命名空间。 |
9.1.9. .spec.agent.ipfix.ovnKubernetes
- 描述
-
ovnKubernetes
定义 OVN-Kubernetes CNI 的设置(如果可用)。在没有 OpenShift Container Platform 的情况下使用 OVN 的 IPFIX 导出时使用此配置。使用 OpenShift Container Platform 时,请参阅clusterNetworkOperator
属性。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 部署 OVN-Kubernetes pod 的命名空间。 |
9.1.10. .spec.consolePlugin
- 描述
-
ConsolePlugin
定义与 OpenShift Container Platform 控制台插件相关的设置(如果可用)。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
Pod 横向自动扩展的 |
|
| 启用 console 插件 deployment. spec.Loki.enable 还必须为 true |
|
|
|
|
|
控制台插件后端的 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9.1.11. .spec.consolePlugin.autoscaler
- 描述
-
Pod 横向自动扩展的
autoscaler
规格来为插件部署设置。请参阅 HorizontalPodAutoscaler 文档(autoscaling/v2)。 - 类型
-
object
9.1.12. .spec.consolePlugin.portNaming
- 描述
-
portNaming
定义端口到服务名称转换的配置 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 启用 console 插件端口到服务名称转换 |
|
|
|
9.1.13. .spec.consolePlugin.quickFilters
- 描述
-
quickFilters
为 Console 插件配置快速过滤器预设置 - 类型
-
数组
9.1.14. .spec.consolePlugin.quickFilters[]
- 描述
-
QuickFilter
为控制台的快速过滤器定义预设置配置 - 类型
-
对象
- 必填
-
filter
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 过滤器的名称,在控制台中显示 |
9.1.15. .spec.consolePlugin.resources
- 描述
-
resources
,根据此容器所需的计算资源。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
9.1.16. .spec.exporters
- 描述
-
exporters
为自定义消耗或存储定义了额外的可选导出器。 - 类型
-
数组
9.1.17. .spec.exporters[]
- 描述
-
FlowCollectorExporter
定义了一个额外的导出器来发送增强的流 - 类型
-
对象
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| IPFIX 配置,如 IP 地址和端口,以将增强的 IPFIX 流发送到。 |
|
| Kafka 配置(如地址和主题)将增强的流发送到。 |
|
|
|
9.1.18. .spec.exporters[].ipfix
- 描述
- IPFIX 配置,如 IP 地址和端口,以将增强的 IPFIX 流发送到。
- 类型
-
对象
- 必填
-
targetHost
-
targetPort
-
属性 | 类型 | 描述 |
---|---|---|
|
| IPFIX 外部接收器的地址 |
|
| IPFIX 外部接收器的端口 |
|
|
用于 IPFIX 连接的传输协议( |
9.1.19. .spec.exporters[].kafka
- 描述
- Kafka 配置(如地址和主题)将增强的流发送到。
- 类型
-
对象
- 必填
-
address
-
topic
-
属性 | 类型 | 描述 |
---|---|---|
|
| Kafka 服务器的地址 |
|
| SASL 身份验证配置。[Unsupported packagemanifests]。 |
|
| TLS 客户端配置。在使用 TLS 时,验证地址是否与用于 TLS 的 Kafka 端口匹配,通常为 9093。 |
|
| 要使用的 Kafka 主题。它必须存在。Network Observability 不会创建它。 |
9.1.20. .spec.exporters[].kafka.sasl
- 描述
- SASL 身份验证配置。[Unsupported packagemanifests]。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 对包含客户端 ID 的 secret 或配置映射的引用 |
|
| 对包含客户端 secret 的 secret 或配置映射的引用 |
|
|
使用的 SASL 身份验证类型,如果没有使用 SASL,则为 |
9.1.21. .spec.exporters[].kafka.sasl.clientIDReference
- 描述
- 对包含客户端 ID 的 secret 或配置映射的引用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 配置映射或 secret 中的文件名 |
|
| 包含该文件的配置映射或 secret 的名称 |
|
| 包含该文件的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
| 文件引用的 type: "configmap" 或 "secret" |
9.1.22. .spec.exporters[].kafka.sasl.clientSecretReference
- 描述
- 对包含客户端 secret 的 secret 或配置映射的引用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 配置映射或 secret 中的文件名 |
|
| 包含该文件的配置映射或 secret 的名称 |
|
| 包含该文件的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
| 文件引用的 type: "configmap" 或 "secret" |
9.1.23. .spec.exporters[].kafka.tls
- 描述
- TLS 客户端配置。在使用 TLS 时,验证地址是否与用于 TLS 的 Kafka 端口匹配,通常为 9093。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
| 启用 TLS |
|
|
|
|
|
|
9.1.24. .spec.exporters[].kafka.tls.caCert
- 描述
-
caCert
定义证书颁发机构的证书引用 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.25. .spec.exporters[].kafka.tls.userCert
- 描述
-
userCert
定义用户证书引用,用于 mTLS (您可以在使用单向 TLS 时忽略它) - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.26. .spec.kafka
- 描述
-
Kafka 配置,允许使用 Kafka 作为流集合管道的一部分。当
spec.deploymentModel
为KAFKA
时可用。 - 类型
-
对象
- 必填
-
address
-
topic
-
属性 | 类型 | 描述 |
---|---|---|
|
| Kafka 服务器的地址 |
|
| SASL 身份验证配置。[Unsupported packagemanifests]。 |
|
| TLS 客户端配置。在使用 TLS 时,验证地址是否与用于 TLS 的 Kafka 端口匹配,通常为 9093。 |
|
| 要使用的 Kafka 主题。它必须存在,Network Observability 不会创建它。 |
9.1.27. .spec.kafka.sasl
- 描述
- SASL 身份验证配置。[Unsupported packagemanifests]。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 对包含客户端 ID 的 secret 或配置映射的引用 |
|
| 对包含客户端 secret 的 secret 或配置映射的引用 |
|
|
使用的 SASL 身份验证类型,如果没有使用 SASL,则为 |
9.1.28. .spec.kafka.sasl.clientIDReference
- 描述
- 对包含客户端 ID 的 secret 或配置映射的引用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 配置映射或 secret 中的文件名 |
|
| 包含该文件的配置映射或 secret 的名称 |
|
| 包含该文件的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
| 文件引用的 type: "configmap" 或 "secret" |
9.1.29. .spec.kafka.sasl.clientSecretReference
- 描述
- 对包含客户端 secret 的 secret 或配置映射的引用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 配置映射或 secret 中的文件名 |
|
| 包含该文件的配置映射或 secret 的名称 |
|
| 包含该文件的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
| 文件引用的 type: "configmap" 或 "secret" |
9.1.30. .spec.kafka.tls
- 描述
- TLS 客户端配置。在使用 TLS 时,验证地址是否与用于 TLS 的 Kafka 端口匹配,通常为 9093。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
| 启用 TLS |
|
|
|
|
|
|
9.1.31. .spec.kafka.tls.caCert
- 描述
-
caCert
定义证书颁发机构的证书引用 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.32. .spec.kafka.tls.userCert
- 描述
-
userCert
定义用户证书引用,用于 mTLS (您可以在使用单向 TLS 时忽略它) - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.33. .spec.loki
- 描述
- Loki,流存储、客户端设置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
设置为 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Loki 状态 URL 的 TLS 客户端配置。 |
|
|
|
|
|
|
|
|
|
|
| Loki URL 的 TLS 客户端配置。 |
|
|
|
9.1.34. .spec.loki.statusTls
- 描述
- Loki 状态 URL 的 TLS 客户端配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
| 启用 TLS |
|
|
|
|
|
|
9.1.35. .spec.loki.statusTls.caCert
- 描述
-
caCert
定义证书颁发机构的证书引用 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.36. .spec.loki.statusTls.userCert
- 描述
-
userCert
定义用户证书引用,用于 mTLS (您可以在使用单向 TLS 时忽略它) - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.37. .spec.loki.tls
- 描述
- Loki URL 的 TLS 客户端配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
| 启用 TLS |
|
|
|
|
|
|
9.1.38. .spec.loki.tls.caCert
- 描述
-
caCert
定义证书颁发机构的证书引用 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.39. .spec.loki.tls.userCert
- 描述
-
userCert
定义用户证书引用,用于 mTLS (您可以在使用单向 TLS 时忽略它) - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.40. .spec.processor
- 描述
-
processor
定义从代理接收流的组件设置,增强它们,生成指标,并将它们转发到 Loki 持久层和/或任何可用的导出器。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
处理器运行时的 |
|
|
|
|
|
|
|
| 流收集器(主机端口)的端口。按照惯例,一些值会被禁止。它必须大于 1024,且不能是 4500、4789 和 6081。 |
|
|
|
|
|
|
9.1.41. .spec.processor.debug
- 描述
-
debug
允许设置流处理器的内部配置。本节专门用于调试和精细的性能优化,如 GOGC 和 GOMAXPROCS env vars。用户设置其值会自行承担任何风险。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
9.1.42. .spec.processor.kafkaConsumerAutoscaler
- 描述
-
kafkaConsumerAutoscaler
是 Pod 横向自动扩展的 spec,用于flowlogs-pipeline-transformer
,它使用 Kafka 信息。当 Kafka 被禁用时,会忽略此设置。请参阅 HorizontalPodAutoscaler 文档(autoscaling/v2)。 - 类型
-
object
9.1.43. .spec.processor.metrics
- 描述
-
Metrics
定义有关指标的处理器配置 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| Prometheus scraper 的指标服务器端点配置 |
9.1.44. .spec.processor.metrics.server
- 描述
- Prometheus scraper 的指标服务器端点配置
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| prometheus HTTP 端口 |
|
| TLS 配置。 |
9.1.45. .spec.processor.metrics.server.tls
- 描述
- TLS 配置。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
当 |
|
|
当 |
|
|
选择 TLS 配置类型: |
9.1.46. .spec.processor.metrics.server.tls.provided
- 描述
-
当
type
设置为PROVIDED
时,TLS 的配置。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
|
|
|
|
|
| 包含证书的配置映射或 Secret 的名称 |
|
| 包含证书的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
|
证书引用的类型: |
9.1.47. .spec.processor.metrics.server.tls.providedCaFile
- 描述
-
当
type
设置为PROVIDED
时,引用 CA 文件。 - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 配置映射或 secret 中的文件名 |
|
| 包含该文件的配置映射或 secret 的名称 |
|
| 包含该文件的配置映射或 secret 的命名空间。如果省略,则默认为使用与部署 Network Observability 相同的命名空间。如果命名空间不同,则复制配置映射或 secret,以便可以根据需要挂载它。 |
|
| 文件引用的 type: "configmap" 或 "secret" |
9.1.48. .spec.processor.resources
- 描述
-
resources
是此容器所需的计算资源。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
|
| Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。请求不能超过限值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |