第9章 FlowCollector 設定パラメーター


FlowCollector は、基盤となるデプロイメントを操作および設定するネットワークフロー収集 API のスキーマです。

9.1. FlowCollector API 仕様

説明
FlowCollector は、基盤となるデプロイメントを操作および設定するネットワークフロー収集 API のスキーマです。
object
プロパティー説明

apiVersion

string

APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーは、クライアントが要求を送信するエンドポイントからこれを推測できることがあります。これを更新することはできません。キャメルケースを使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

object

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

FlowCollector リソースの望ましい状態を定義します。

*: このドキュメントで "サポート対象外" または "非推奨" と記載されている場合、Red Hat はその機能を公式にサポートしていません。たとえば、コミュニティーによって提供され、メンテナンスに関する正式な合意なしに受け入れられた可能性があります。製品のメンテナーは、ベストエフォートに限定してこれらの機能に対するサポートを提供する場合があります。

9.1.1. .metadata

説明
標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
object

9.1.2. .spec

説明
FlowCollector リソースの望ましい状態を定義します。

*: このドキュメントで "サポート対象外" または "非推奨" と記載されている場合、Red Hat はその機能を公式にサポートしていません。たとえば、コミュニティーによって提供され、メンテナンスに関する正式な合意なしに受け入れられた可能性があります。製品のメンテナーは、ベストエフォートに限定してこれらの機能に対するサポートを提供する場合があります。
object
プロパティー説明

agent (エージェント)

object

フローを展開するためのエージェント設定。

consolePlugin

object

consolePlugin は、利用可能な場合、OpenShift Container Platform コンソールプラグインに関連する設定を定義します。

deploymentModel

string

deploymentModel は、フロー処理に必要なデプロイメントのタイプを定義します。使用できる値は次のとおりです。
- DIRECT (デフォルト): フロープロセッサーがエージェントから直接リッスンするようにします。
- KAFKA は、プロセッサーによって消費される前にフローを Kafka パイプラインに送信するようにします。
Kafka は、より優れたスケーラビリティ、回復性、および高可用性を提供できます (詳細は、https://www.redhat.com/en/topics/integration/what-is-apache-kafka を参照してください)。

exporters

array

exporters は、カスタム消費またはストレージ用の追加のオプションのエクスポータを定義します。

kafka

object

Kafka 設定。Kafka をフローコレクションパイプラインの一部としてブローカーとして使用できます。spec.deploymentModelKAFKA の場合に利用できます。

loki

object

ロキ、フローストア、クライアント設定。

namespace

string

Network Observability Pod がデプロイされる namespace。

processor

object

processor は、エージェントからフローを受信し、それを強化し、メトリクスを生成し、 Loki 永続化レイヤーや使用可能なエエクスポーターに転送するコンポーネントの設定を定義します。

9.1.3. .spec.agent

説明
フローを展開するためのエージェント設定。
object
プロパティー説明

ebpf

object

ebpf は、spec.agent.typeEBPF に設定されている場合の eBPF ベースのフローレポーターに関連する設定を説明します。

ipfix

object

ipfix [非推奨 (*)] - spec.agent.typeIPFIX に設定されている場合の IPFIX ベースのフローレポーターに関連する設定を記述します。

type

string

type は、フロートレースエージェントを選択します。使用可能な値は次のとおりです。
- Network Observability eBPF agent を使用する場合は EBPF (デフォルト)。
- レガシー IPFIX コレクターを使用する場合は IPFIX [非推奨 (*)] です。
EBPF は、より優れたパフォーマンスを提供し、クラスターにインストールされている CNI に関係なく動作するため、推奨されます。IPFIX は OVN-Kubernetes CNI で動作します (IPFIX のエクスポートをサポートしている場合は、他の CNI も動作しますが、手動設定が必要になります)。

9.1.4. .spec.agent.ebpf

説明
ebpf は、spec.agent.typeEBPF に設定されている場合の eBPF ベースのフローレポーターに関連する設定を説明します。
object
プロパティー説明

cacheActiveTimeout

string

cacheActiveTimeout は、レポーターがフローを集約して送信するまでの最大期間です。cacheMaxFlowscacheActiveTimeout を増やすと、ネットワークトラフィックのオーバーヘッドと CPU 負荷を減らすことができますが、メモリー消費量が増え、フローコレクションのレイテンシーが増加することが予想されます。

cacheMaxFlows

integer

cacheMaxFlows は、集約内のフローの最大数です。到達すると、レポーターはフローを送信します。cacheMaxFlowscacheActiveTimeout を増やすと、ネットワークトラフィックのオーバーヘッドと CPU 負荷を減らすことができますが、メモリー消費量が増え、フローコレクションのレイテンシーが増加することが予想されます。

debug

object

debug では、eBPF エージェントの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと、GOGC や GOMAXPROCS 環境変数などのきめ細かいパフォーマンスの最適化のみを目的としています。その値を設定するユーザーは、自己責任で行ってください。

excludeInterfaces

array (string)

excludeInterfaces には、フロートレースから除外するインターフェイス名を含めます。/br-/ など、スラッシュで囲まれたエントリーは正規表現として照合されます。それ以外は、大文字と小文字を区別する文字列として照合されます。

features

array (string)

有効にする追加機能のリスト。これらはデフォルトですべて無効になっています。追加機能を有効にすると、パフォーマンスに影響が出る可能性があります。使用できる値は、次のとおりです。
- PacketDrop は、パケットドロップフローのロギングを有効にします。この機能を使用する場合はカーネルデバッグファイルシステムをマウントする必要があるため、eBPF Pod は特権付きとして実行する必要があります。spec.agent.eBPF.privileged パラメーターが設定されていない場合はエラーが報告されます。
- DNSTracking は、DNS 追跡機能を有効にします。この機能を使用する場合はカーネルデバッグファイルシステムをマウントする必要があるため、eBPF Pod は特権付きとして実行する必要があります。spec.agent.eBPF.privileged パラメーターが設定されていない場合、エラーが報告されます。
- FlowRTT [サポート対象外 (*)]: TCP ハンドシェイク中に eBPF agent でのフローレイテンシー (RTT) 計算を有効にします。この機能は、sampling を 1 に設定するとより適切に機能します。

imagePullPolicy

string

imagePullPolicy は、上で定義したイメージの Kubernetes プルポリシーです。

interfaces

array (string)

interfaces には、フローの収集元であるインターフェイスの名前を含めます。空の場合、エージェントは ExcludeInterfaces にリストされているものを除いて、システム内のすべてのインターフェイスを取得します。/br-/ など、スラッシュで囲まれたエントリーは正規表現として照合されます。それ以外は、大文字と小文字を区別する文字列として照合されます。

kafkaBatchSize

integer

kafkaBatchSize は、パーティションに送信される前のリクエストの最大サイズをバイト単位で制限します。Kafka を使用しない場合は無視されます。デフォルト: 10MB。

logLevel

string

logLevel は、Network Observability eBPF Agent のログレベルを定義します。

privileged

boolean

eBPF Agent コンテナーの特権モード。一般的には、この設定は無視するか、false に設定します。その場合、Operator はコンテナーに詳細な機能 (BPF、PERFMON、NET_ADMIN、SYS_RESOURCE) を設定して、正しい操作を有効にします。CAP_BPF を認識しない古いカーネルバージョンが使用されている場合など、何らかの理由でこれらの機能を設定できない場合は、このモードをオンにして、より多くのグローバル権限を取得できます。

resources

object

resources は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

sampling

integer

フローレポーターのサンプリングレート。100 は、100 の 1 つのフローが送信されることを意味します。0 または 1 は、すべてのフローがサンプリングされることを意味します。

9.1.5. .spec.agent.ebpf.debug

説明
debug では、eBPF エージェントの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと、GOGC や GOMAXPROCS 環境変数などのきめ細かいパフォーマンスの最適化のみを目的としています。その値を設定するユーザーは、自己責任で行ってください。
object
プロパティー説明

env

object (string)

env を使用すると、カスタム環境変数を基礎となるコンポーネントに渡すことができます。GOGC や GOMAXPROCS などの非常に具体的なパフォーマンスチューニングオプションを渡すのに役立ちます。これらは、エッジデバッグまたはサポートシナリオでのみ有用であるため、FlowCollector 記述子の一部として公開すべきではありません。

9.1.6. .spec.agent.ebpf.resources

説明
resources は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
object
プロパティー説明

limits

integer-or-string

制限は、許容されるコンピュートリソースの最大量を記述します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

integer-or-string

要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

9.1.7. .spec.agent.ipfix

説明
ipfix [非推奨 (*)] - spec.agent.typeIPFIX に設定されている場合の IPFIX ベースのフローレポーターに関連する設定を記述します。
object
プロパティー説明

cacheActiveTimeout

string

cacheActiveTimeout は、レポーターがフローを集約して送信するまでの最大期間です。

cacheMaxFlows

integer

cacheMaxFlows は、集約内のフローの最大数です。到達すると、レポーターはフローを送信します。

clusterNetworkOperator

object

clusterNetworkOperator は、利用可能な場合、OpenShift Container Platform Cluster Network Operator に関連する設定を定義します。

forceSampleAll

boolean

forceSampleAll を使用すると、IPFIX ベースのフローレポーターでのサンプリングを無効にできます。クラスターが不安定になる可能性があるため、IPFIX を使用してすべてのトラフィックをサンプリングすることは推奨しません。本当にそうしたい場合は、このフラグを true に設定してください。自己責任でお使いください。true に設定すると、sampling の値は無視されます。

ovnKubernetes

object

ovnKubernetes は、利用可能な場合、OVN-Kubernetes CNI の設定を定義します。この設定は、OpenShift Container Platform なしで OVN の IPFIX エクスポートを使用する場合に使用されます。OpenShift Container Platform を使用する場合は、代わりに clusterNetworkOperator プロパティーを参照してください。

sampling

integer

sampling は、レポーターのサンプリングレートです。100 は、100 の 1 つのフローが送信されることを意味します。クラスターの安定性を確保するために、2 未満の値を設定することはできません。クラスターの安定性に影響を与える可能性があるすべてのパケットを本当にサンプリングしたい場合は、forceSampleAll を参照してください。または、IPFIX の代わりに eBPF エージェントを使用できます。

9.1.8. .spec.agent.ipfix.clusterNetworkOperator

説明
clusterNetworkOperator は、利用可能な場合、OpenShift Container Platform Cluster Network Operator に関連する設定を定義します。
object
プロパティー説明

namespace

string

ConfigMap がデプロイされる namespace。

9.1.9. .spec.agent.ipfix.ovnKubernetes

説明
ovnKubernetes は、利用可能な場合、OVN-Kubernetes CNI の設定を定義します。この設定は、OpenShift Container Platform なしで OVN の IPFIX エクスポートを使用する場合に使用されます。OpenShift Container Platform を使用する場合は、代わりに clusterNetworkOperator プロパティーを参照してください。
object
プロパティー説明

containerName

string

containerName は、IPFIX 用に設定するコンテナーの名前を定義します。

daemonSetName

string

daemonSetName は、OVN-Kubernetes Pod を制御する DaemonSet の名前を定義します。

namespace

string

OVN-Kubernetes Pod がデプロイされる namespace。

9.1.10. .spec.consolePlugin

説明
consolePlugin は、利用可能な場合、OpenShift Container Platform コンソールプラグインに関連する設定を定義します。
object
プロパティー説明

autoscaler

object

プラグインのデプロイメント用に設定する水平 Pod オートスケーラーの autoscaler 仕様。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。

enable

boolean

コンソールプラグインのデプロイメントを有効にします。spec.Loki.enable も true にする必要があります

imagePullPolicy

string

imagePullPolicy は、上で定義したイメージの Kubernetes プルポリシーです。

logLevel

string

コンソールプラグインバックエンドの logLevel

port

integer

port はプラグインサービスポートです。メトリクス用に予約されている 9002 は使用しないでください。

portNaming

object

portNaming は、ポートからサービス名への変換の設定を定義します。

quickFilters

array

quickFilters は、コンソールプラグインのクイックフィルタープリセットを設定します。

register

boolean

register を true に設定すると、提供されたコンソールプラグインを OpenShift Container Platform Console Operator に自動的に登録できます。false に設定した場合でも、oc patch console.operator.openshift.io cluster --type='json' -p '[{"op": "add", "path": "/spec/plugins/-", "value": "netobserv-plugin"}]' コマンドで console.operator.openshift.io/cluster を編集することにより、手動で登録できます。

replicas

integer

replicas は、開始するレプリカ (Pod) の数を定義します。

resources

object

resources (コンピューティングリソースから見た場合にコンテナーに必要)。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

9.1.11. .spec.consolePlugin.autoscaler

説明
プラグインのデプロイメント用に設定する水平 Pod オートスケーラーの autoscaler 仕様。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。
object

9.1.12. .spec.consolePlugin.portNaming

説明
portNaming は、ポートからサービス名への変換の設定を定義します。
object
プロパティー説明

enable

boolean

コンソールプラグインのポートからサービス名への変換を有効にします。

portNames

object (string)

portNames は、コンソールで使用する追加のポート名を定義します (例: portNames: {"3100": "loki"})。

9.1.13. .spec.consolePlugin.quickFilters

説明
quickFilters は、コンソールプラグインのクイックフィルタープリセットを設定します。
array

9.1.14. .spec.consolePlugin.quickFilters[]

説明
QuickFilter は、コンソールのクイックフィルターのプリセット設定を定義します。
object
必須
  • filter
  • name
プロパティー説明

default

boolean

default は、このフィルターをデフォルトで有効にするかどうかを定義します。

filter

object (string)

filter は、このフィルターが選択されたときに設定されるキーと値のセットです。各キーは、コンマ区切りの文字列を使用して値のリストに関連付けることができます (例: filter: {"src_namespace": "namespace1,namespace2"})。

name

string

コンソールに表示されるフィルターの名前

9.1.15. .spec.consolePlugin.resources

説明
resources (コンピューティングリソースから見た場合にコンテナーに必要)。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
object
プロパティー説明

limits

integer-or-string

制限は、許容されるコンピュートリソースの最大量を記述します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

integer-or-string

要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

9.1.16. .spec.exporters

説明
exporters は、カスタム消費またはストレージ用の追加のオプションのエクスポータを定義します。
array

9.1.17. .spec.exporters[]

説明
FlowCollectorExporter は、強化されたフローを送信する追加のエクスポーターを定義します。
object
必須
  • type
プロパティー説明

ipfix

object

強化された IPFIX フローの送信先となる、IP アドレスやポートなどの IPFIX 設定。

kafka

object

強化されたフローの送信先となる、アドレスやトピックなどの Kafka 設定。

type

string

type は、エクスポーターのタイプを選択します。使用可能なオプションは KAFKA および IPFIX です。

9.1.18. .spec.exporters[].ipfix

説明
強化された IPFIX フローの送信先となる、IP アドレスやポートなどの IPFIX 設定。
object
必須
  • targetHost
  • targetPort
プロパティー説明

targetHost

string

IPFIX 外部レシーバーのアドレス

targetPort

integer

IPFIX 外部レシーバー用のポート

transport

string

IPFIX 接続に使用されるトランスポートプロトコル (TCP または UDP)。デフォルトは TCP です。

9.1.19. .spec.exporters[].kafka

説明
強化されたフローの送信先となる、アドレスやトピックなどの Kafka 設定。
object
必須
  • address
  • topic
プロパティー説明

address

string

Kafka サーバーのアドレス

sasl

object

SASL 認証の設定。[サポート対象外 (*)]。

tls

object

TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。

topic

string

使用する Kafka トピック。これは必ず存在する必要があります。ネットワーク可観測性はこれを作成しません。

9.1.20. .spec.exporters[].kafka.sasl

説明
SASL 認証の設定。[サポート対象外 (*)]。
object
プロパティー説明

clientIDReference

object

クライアント ID を含むシークレットまたは config map への参照

clientSecretReference

object

クライアントシークレットを含むシークレットまたは config map への参照

type

string

使用する SASL 認証のタイプ。SASL を使用しない場合は DISABLED

9.1.21. .spec.exporters[].kafka.sasl.clientIDReference

説明
クライアント ID を含むシークレットまたは config map への参照
object
プロパティー説明

file

string

config map またはシークレット内のファイル名

name

string

ファイルを含む config map またはシークレットの名前

namespace

string

ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

ファイル参照のタイプ: "configmap" または "secret"

9.1.22. .spec.exporters[].kafka.sasl.clientSecretReference

説明
クライアントシークレットを含むシークレットまたは config map への参照
object
プロパティー説明

file

string

config map またはシークレット内のファイル名

name

string

ファイルを含む config map またはシークレットの名前

namespace

string

ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

ファイル参照のタイプ: "configmap" または "secret"

9.1.23. .spec.exporters[].kafka.tls

説明
TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。
object
プロパティー説明

cacert

object

caCert は、認証局の証明書の参照を定義します。

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

insecureSkipVerify を使用すると、サーバー証明書のクライアント側の検証をスキップできます。true に設定すると、caCert フィールドは無視されます。

userCert

object

userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。

9.1.24. .spec.exporters[].kafka.tls.caCert

説明
caCert は、認証局の証明書の参照を定義します。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.25. .spec.exporters[].kafka.tls.userCert

説明
userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.26. .spec.kafka

説明
Kafka 設定。Kafka をフローコレクションパイプラインの一部としてブローカーとして使用できます。spec.deploymentModelKAFKA の場合に利用できます。
object
必須
  • address
  • topic
プロパティー説明

address

string

Kafka サーバーのアドレス

sasl

object

SASL 認証の設定。[サポート対象外 (*)]。

tls

object

TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。

topic

string

使用する Kafka トピック。これは必ず存在する必要があり、ネットワーク可観測性はこれを作成しません。

9.1.27. .spec.kafka.sasl

説明
SASL 認証の設定。[サポート対象外 (*)]。
object
プロパティー説明

clientIDReference

object

クライアント ID を含むシークレットまたは config map への参照

clientSecretReference

object

クライアントシークレットを含むシークレットまたは config map への参照

type

string

使用する SASL 認証のタイプ。SASL を使用しない場合は DISABLED

9.1.28. .spec.kafka.sasl.clientIDReference

説明
クライアント ID を含むシークレットまたは config map への参照
object
プロパティー説明

file

string

config map またはシークレット内のファイル名

name

string

ファイルを含む config map またはシークレットの名前

namespace

string

ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

ファイル参照のタイプ: "configmap" または "secret"

9.1.29. .spec.kafka.sasl.clientSecretReference

説明
クライアントシークレットを含むシークレットまたは config map への参照
object
プロパティー説明

file

string

config map またはシークレット内のファイル名

name

string

ファイルを含む config map またはシークレットの名前

namespace

string

ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

ファイル参照のタイプ: "configmap" または "secret"

9.1.30. .spec.kafka.tls

説明
TLS クライアント設定。TLS を使用する場合は、アドレスが TLS に使用される Kafka ポート (通常は 9093) と一致することを確認します。
object
プロパティー説明

cacert

object

caCert は、認証局の証明書の参照を定義します。

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

insecureSkipVerify を使用すると、サーバー証明書のクライアント側の検証をスキップできます。true に設定すると、caCert フィールドは無視されます。

userCert

object

userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。

9.1.31. .spec.kafka.tls.caCert

説明
caCert は、認証局の証明書の参照を定義します。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.32. .spec.kafka.tls.userCert

説明
userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.33. .spec.loki

説明
ロキ、フローストア、クライアント設定。
object
プロパティー説明

authToken

string

authToken は、Loki に対して認証するためのトークンを取得する方法を記述します。
- DISABLED は、要求に対してトークンを送信しません。
- FORWARD は、認可のためにユーザートークンを転送します。
- HOST - [非推奨 (*)] - Loki に対する認証にローカル Pod サービスアカウントを使用します。
Loki Operator を使用する場合、FORWARD に設定する必要があります。

batchSize

integer

batchSize は、送信前に蓄積するログの最大バッチサイズ (バイト単位) です。

batchWait

string

batchWait は、バッチを送信するまでに待機する最大時間です。

enable

boolean

フローを Loki に保存する場合は enable に設定します。これは、OpenShift Container Platform コンソールプラグインのインストールに必要です。

maxBackoff

string

maxBackoff は、再試行間のクライアント接続の最大バックオフ時間です。

maxRetries

integer

maxRetries は、クライアント接続の最大再試行回数です。

minBackoff

string

minBackoff は、再試行間のクライアント接続の初期バックオフ時間です。

querierUrl

string

querierURL は、Loki インジェスター URL とは異なる場合に備えて、Loki クエリーアサービスのアドレスを指定します。空の場合、URL 値が使用されます (Loki インジェスターとクエリアが同じサーバー内にあると仮定します)。Loki Operator を使用する場合は、取り込みとクエリーに Loki ゲートウェイが使用されるため設定しないでください。

staticLabels

object (string)

staticLabels は、各フローに設定する共通ラベルのマップです。

statusTls

object

Loki ステータス URL の TLS クライアント設定。

statusUrl

string

statusURL は、Loki クエリア URL と異なる場合に備えて、Loki /ready/metrics/config エンドポイントのアドレスを指定します。空の場合、querierURL 値が使用されます。これは、フロントエンドでエラーメッセージやコンテキストを表示するのに便利です。Loki Operator を使用する場合は、Loki HTTP クエリーフロントエンドサービス (例 : https://loki-query-frontend-http.netobserv.svc:3100/) に設定します。statusTLS 設定は、statusUrl が設定されている場合に使用されます。

tenantID

string

tenantID は、各リクエストのテナントを識別する Loki X-Scope-OrgID です。Loki Operator を使用する場合は、特別なテナントモードに対応する network に設定します。

timeout

string

timeout は、接続/リクエスト時間の上限です。タイムアウトがゼロの場合は、タイムアウトしません。

tls

object

Loki URL の TLS クライアント設定。

url

string

url は、フローをプッシュする既存の Loki サービスのアドレスです。Loki Operator を使用する場合は、パスに network テナントが設定された Loki ゲートウェイサービスに設定します (例: https://loki-gateway-http.netobserv.svc:8080/api/logs/v1/network)。

9.1.34. .spec.loki.statusTls

説明
Loki ステータス URL の TLS クライアント設定。
object
プロパティー説明

cacert

object

caCert は、認証局の証明書の参照を定義します。

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

insecureSkipVerify を使用すると、サーバー証明書のクライアント側の検証をスキップできます。true に設定すると、caCert フィールドは無視されます。

userCert

object

userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。

9.1.35. .spec.loki.statusTls.caCert

説明
caCert は、認証局の証明書の参照を定義します。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.36. .spec.loki.statusTls.userCert

説明
userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.37. .spec.loki.tls

説明
Loki URL の TLS クライアント設定。
object
プロパティー説明

cacert

object

caCert は、認証局の証明書の参照を定義します。

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

insecureSkipVerify を使用すると、サーバー証明書のクライアント側の検証をスキップできます。true に設定すると、caCert フィールドは無視されます。

userCert

object

userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。

9.1.38. .spec.loki.tls.caCert

説明
caCert は、認証局の証明書の参照を定義します。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.39. .spec.loki.tls.userCert

説明
userCert は、mTLS に使用されるユーザー証明書参照を定義します (一方向 TLS を使用する場合は無視できます)。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.40. .spec.processor

説明
processor は、エージェントからフローを受信し、それを強化し、メトリクスを生成し、 Loki 永続化レイヤーや使用可能なエエクスポーターに転送するコンポーネントの設定を定義します。
object
プロパティー説明

clusterName

string

clusterName は、フローデータに表示されるクラスターの名前です。これは、マルチクラスターコンテキストで役立ちます。OpenShift Container Platform を使用する場合は、自動的に決定されるように空のままにします。

conversationEndTimeout

string

conversationEndTimeout は、ネットワークフローを受信した後、対話が終了したとみなされるまでの待機時間です。TCP フローの FIN パケットが収集される場合、この遅延は無視されます (代わりに、conversationTerminatingTimeout を使用します)。

conversationHeartbeatInterval

string

conversationHeartbeatInterval は、対話の "tick" イベント間の待機時間です。

conversationTerminatingTimeout

string

conversationTerminatingTimeout、FIN フラグが検知されてから対話が終了するまでの待機時間です。TCP フローにのみ関連します。

debug

object

debug では、フロープロセッサーの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと、GOGC や GOMAXPROCS 環境変数などのきめ細かいパフォーマンスの最適化のみを目的としています。その値を設定するユーザーは、自己責任で行ってください。

dropUnusedFields

boolean

dropUnusedFields を true に設定すると、OVS によって未使用であることがわかっているフィールドを削除して、ストレージ領域を節約できます。

enableKubeProbes

boolean

enableKubeProbes は、Kubernetes の liveness および readiness プローブを有効または無効にするフラグです。

healthPort

integer

healthPort は、ヘルスチェック API を公開する Pod のコレクター HTTP ポートです。

imagePullPolicy

string

imagePullPolicy は、上で定義したイメージの Kubernetes プルポリシーです。

kafkaConsumerAutoscaler

object

kafkaConsumerAutoscaler は、Kafka メッセージを消費する flowlogs-pipeline-transformer を設定する水平 Pod オートスケーラーの仕様です。Kafka が無効になっている場合、この設定は無視されます。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。

kafkaConsumerBatchSize

integer

kafkaConsumerBatchSize は、コンシューマーが受け入れる最大バッチサイズ (バイト単位) をブローカーに示します。Kafka を使用しない場合は無視されます。デフォルト: 10MB。

kafkaConsumerQueueCapacity

integer

kafkaConsumerQueueCapacity は、Kafka コンシューマークライアントで使用される内部メッセージキューの容量を定義します。Kafka を使用しない場合は無視されます。

kafkaConsumerReplicas

integer

kafkaConsumerReplicas は、Kafka メッセージを消費する flowlogs-pipeline-transformer に対して開始するレプリカ (Pod) の数を定義します。Kafka が無効になっている場合、この設定は無視されます。

logLevel

string

プロセッサーランタイムの logLevel

logTypes

string

logTypes は、生成するレコードタイプを定義します。可能な値は次のとおりです。
- FLOWS (デフォルト): 通常のネットワークフローをエクスポートします。
- CONVERSATIONS: 開始された対話、終了した対話、および定期的な "tick" 更新のイベントを生成します。
- ENDED_CONVERSATIONS: 終了した対話イベントのみ生成します。
- ALL: ネットワークフローとすべての対話イベントの両方を生成します。

metrics

object

Metric は、メトリクスに関するプロセッサー設定を定義します。

port

integer

フローコレクターのポート (ホストポート)。慣例により、一部の値は禁止されています。1024 より大きい値とし、4500、4789、6081 は使用できません。

profilePort

integer

profilePort を使用すると、このポートをリッスンする Go pprof プロファイラーを設定できます

resources

object

resources は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

9.1.41. .spec.processor.debug

説明
debug では、フロープロセッサーの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと、GOGC や GOMAXPROCS 環境変数などのきめ細かいパフォーマンスの最適化のみを目的としています。その値を設定するユーザーは、自己責任で行ってください。
object
プロパティー説明

env

object (string)

env を使用すると、カスタム環境変数を基礎となるコンポーネントに渡すことができます。GOGC や GOMAXPROCS などの非常に具体的なパフォーマンスチューニングオプションを渡すのに役立ちます。これらは、エッジデバッグまたはサポートシナリオでのみ有用であるため、FlowCollector 記述子の一部として公開すべきではありません。

9.1.42. .spec.processor.kafkaConsumerAutoscaler

説明
kafkaConsumerAutoscaler は、Kafka メッセージを消費する flowlogs-pipeline-transformer を設定する水平 Pod オートスケーラーの仕様です。Kafka が無効になっている場合、この設定は無視されます。HorizontalPodAutoscaler のドキュメント (自動スケーリング/v2) を参照してください。
object

9.1.43. .spec.processor.metrics

説明
Metric は、メトリクスに関するプロセッサー設定を定義します。
object
プロパティー説明

disableAlerts

array (string)

disableAlerts は、無効にする必要があるアラートのリストです。可能な値は次のとおりです:
NetObservNoFlows: 一定期間フローが観察されなかった場合にトリガーされます。
NetObservLokiError: Loki エラーが原因でフローがドロップされるとトリガーされます。

ignoreTags

array (string)

ignoreTags は、無視するメトリクスを指定するタグのリストです。各メトリクスはタグのリストに関連付けられています。詳細は、https://github.com/netobserv/network-observability-operator/tree/main/controllers/flowlogspipeline/metrics_settings を参照してください。使用可能なタグは、egressingressflowsbytespacketnamespacesnodeworkloadsnodes-flowsnamespaces-flowsworkloads-flows です。namespace ベースのメトリクスは、workloads タグと namespace タグの両方でカバーされるため、常にいずれか 1 つを無視することが推奨されます (workloads の方が粒度が小さい)。

server

object

Prometheus スクレイパーの metricsServer エンドポイント設定

9.1.44. .spec.processor.metrics.server

説明
Prometheus スクレイパーの metricsServer エンドポイント設定
object
プロパティー説明

port

integer

Prometheus HTTP ポート

tls

object

TLS 設定。

9.1.45. .spec.processor.metrics.server.tls

説明
TLS 設定。
object
プロパティー説明

insecureSkipVerify

boolean

insecureSkipVerify を使用すると、提供された証明書に対するクライアント側の検証をスキップできます。true に設定すると、providedCaFile フィールドが無視されます。

provided

object

typePROVIDED に設定されている場合の TLS 設定。

providedCaFile

object

typePROVIDED に設定されている場合の CA ファイルへの参照。

type

string

TLS 設定のタイプを選択します。
- DISABLED (デフォルト) は、エンドポイントに TLS を設定しません。- PROVIDED は、証明書ファイルとキーファイルを手動で指定します。- AUTO は、アノテーションを使用して OpenShift Container Platform の自動生成証明書を使用します。

9.1.46. .spec.processor.metrics.server.tls.provided

説明
typePROVIDED に設定されている場合の TLS 設定。
object
プロパティー説明

certFile

string

certFile は、config map またはシークレット内の証明書ファイル名へのパスを定義します

certKey

string

certKey は、config map またはシークレット内の証明書秘密鍵ファイル名へのパスを定義します。キーが不要な場合は省略します。

name

string

証明書を含む config map またはシークレットの名前

namespace

string

証明書を含む config map またはシークレットの namespace省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

証明書参照のタイプ: configmap または secret

9.1.47. .spec.processor.metrics.server.tls.providedCaFile

説明
typePROVIDED に設定されている場合の CA ファイルへの参照。
object
プロパティー説明

file

string

config map またはシークレット内のファイル名

name

string

ファイルを含む config map またはシークレットの名前

namespace

string

ファイルを含む config map またはシークレットの namespace。省略した場合、デフォルトでは、ネットワーク可観測性がデプロイされているのと同じ namespace が使用されます。namespace が異なる場合は、必要に応じてマウントできるように、config map またはシークレットがコピーされます。

type

string

ファイル参照のタイプ: "configmap" または "secret"

9.1.48. .spec.processor.resources

説明
resources は、このコンテナーが必要とするコンピューティングリソースです。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。
object
プロパティー説明

limits

integer-or-string

制限は、許容されるコンピュートリソースの最大量を記述します。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

requests

integer-or-string

要求は、必要なコンピュートリソースの最小量を記述します。コンテナーについて Requests が省略される場合、明示的に指定される場合にデフォルトで Limits に設定されます。指定しない場合は、実装定義の値に設定されます。リクエストは制限を超えることはできません。詳細は、https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ を参照してください。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.