第12章 FlowCollector API リファレンス

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.deploymentModel が Kafka の場合です。

loki

object

loki (フローストア) のクライアント設定。

namespace

string

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

processor

object

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

prometheus

object

prometheus は、コンソールプラグインからメトリクスを取得するために使用されるクエリー設定などの Prometheus 設定を定義します。

ebpf

object

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

type

string

type [非推奨 (*)] では、フロートレースエージェントを選択します。以前は、このフィールドでは eBPF または IPFIX を選択できました。現在、eBPF のみが許可されているため、このフィールドは非推奨であり、API の今後のバージョンで削除される予定です。

advanced

object

advanced を使用すると、eBPF エージェントの内部設定のいくつかの側面を設定できます。このセクションは、GOGC や GOMAXPROCS 環境変数などのデバッグと詳細なパフォーマンスの最適化を主な目的としています。これらの値はお客様の責任のもと設定してください。

cacheActiveTimeout

string

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

cacheMaxFlows

integer

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

excludeInterfaces

array (string)

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

features

array (string)

有効にする追加機能のリスト。これらはデフォルトですべて無効になっています。追加機能を有効にすると、パフォーマンスに影響が出る可能性があります。可能な値は次のとおりです。

- PacketDrop: パケットドロップフローのロギング機能を有効にします。この機能を使用する場合はカーネルデバッグファイルシステムをマウントする必要があるため、eBPF Pod は特権付きとして実行する必要があります。spec.agent.ebpf.privileged パラメーターが設定されていない場合は、エラーが報告されます。

- DNSTracking: DNS 追跡機能を有効にします。

- FlowRTT: eBPF エージェントで TCP トラフィックからのフロー遅延 (sRTT) 抽出を有効にします。

flowFilter

object

flowFilter は、フローフィルタリングに関する eBPF エージェント設定を定義します。

imagePullPolicy

string

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

interfaces

array (string)

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

kafkaBatchSize

integer

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

logLevel

string

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

metrics

object

metrics は、メトリクスに関する eBPF エージェント設定を定義します。

privileged

boolean

eBPF Agent コンテナーの特権モード。無視されるか false に設定されていると、Operator がコンテナーに詳細なケイパビリティー (BPF、PERFMON、NET_ADMIN、SYS_RESOURCE) を設定します。CAP_BPF を認識しない古いカーネルバージョンが使用されている場合など、何らかの理由でこれらの機能を設定できない場合は、このモードをオンにして、より多くのグローバル権限を取得できます。パケットドロップの追跡 (機能 を参照) や SR-IOV サポートなど、一部のエージェント機能には特権モードが必要です。

resources

object

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

sampling

integer

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

env

object (string)

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

scheduling

object

scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。

affinity

object

指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。

nodeSelector

object (string)

nodeSelector を使用すると、指定した各ラベルを持つノードにのみ Pod をスケジュールできます。ドキュメントについては、https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ を参照してください。

priorityClassName

string

指定した場合、Pod の優先度を示します。ドキュメントについては、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#how-to-use-priority-and-preemption を参照してください。指定されていない場合はデフォルトの優先度が使用され、デフォルトの優先度がない場合は 0 が使用されます。

toleration

array

tolerations は、一致する taint を持つノードに Pod がスケジュールできるようにする toleration のリストです。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。

action

string

action は、フィルターに一致するフローに対して実行するアクションを定義します。

cidr

string

cidr は、フローのフィルタリングに使用する IP CIDR を定義します。たとえば、10.10.10.0/24 または 100:100:100:100::/64 です。

destPorts

integer-or-string

destPorts は、フローのフィルタリングに使用する宛先ポートを定義します。単一のポートをフィルタリングするには、単一のポートを整数値として設定します。たとえば、destPorts: 80 です。ポートの範囲をフィルタリングするには、文字列形式の "開始 - 終了" 範囲を使用します。たとえば、destPorts: "80-100" です。

direction

string

direction は、フローのフィルタリングに使用する方向を定義します。

enable

boolean

eBPF フローのフィルタリング機能を有効にするには、enable を true に設定します。

icmpCode

integer

icmpCode は、Internet Control Message Protocol (ICMP) トラフィックの場合に、フローのフィルタリングに使用する ICMP コードを定義します。

icmpType

integer

icmpType は、ICMP トラフィックの場合に、フローのフィルタリングに使用する ICMP タイプを定義します。

peerIP

string

peerIP は、フローのフィルタリングに使用する IP アドレスを定義します。たとえば、10.10.10.10 です。

ports

integer-or-string

ports は、フローのフィルタリングに使用するポートを定義します。これは送信元ポートと宛先ポートの両方に使用されます。単一のポートをフィルタリングするには、単一のポートを整数値として設定します。たとえば、ports: 80 です。ポートの範囲をフィルタリングするには、文字列形式の "開始 - 終了" 範囲を使用します。たとえば、ports: "80-100" です。

protocol

string

protocol は、フローのフィルタリングに使用するプロトコルを定義します。

sourcePorts

integer-or-string

sourcePorts は、フローのフィルタリングに使用する送信元ポートを定義します。単一のポートをフィルタリングするには、単一のポートを整数値として設定します。たとえば、sourcePorts: 80 です。ポートの範囲をフィルタリングするには、文字列形式の "開始 - 終了" 範囲を使用します。たとえば、sourcePorts: "80-100" です。

disableAlerts

array (string)

disableAlerts は、無効にする必要があるアラートのリストです。可能な値は次のとおりです。

NetObservDroppedFlows は、BPF の HashMap がいっぱいになったときや容量制限がトリガーされたときなど、eBPF エージェントがフローをドロップしているときにトリガーされます。

enable

boolean

eBPF エージェントのメトリクス収集を無効にするには、enable を false に設定します。これは、デフォルトで有効になっています。

server

object

Prometheus スクレイパーのメトリクスサーバーエンドポイント設定。

port

integer

メトリクスサーバーの HTTP ポート。

tls

object

TLS 設定。

insecureSkipVerify

boolean

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

provided

object

type が Provided に設定されている場合の TLS 設定。

providedCaFile

object

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

type

string

TLS 設定のタイプを選択します。

- Disabled (デフォルト) は、エンドポイントに TLS を設定しません。- Provided は、証明書ファイルとキーファイルを手動で指定します [サポート対象外 (*)]。- Auto は、アノテーションを使用して OpenShift Container Platform の自動生成証明書を使用します。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

file

string

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

name

string

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

namespace

string

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

type

string

ファイル参照のタイプ ("configmap" または "secret")。

limits

integer-or-string

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

requests

integer-or-string

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

advanced

object

advanced を使用すると、コンソールプラグインの内部設定のいくつかの側面を設定できます。このセクションは、GOGC や GOMAXPROCS 環境変数などのデバッグと詳細なパフォーマンスの最適化を主な目的としています。これらの値はお客様の責任のもと設定してください。

autoscaler

object

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

enable

boolean

コンソールプラグインのデプロイメントを有効にします。

imagePullPolicy

string

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

logLevel

string

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

portNaming

object

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

quickFilters

array

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

replicas

integer

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

resources

object

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

args

array (string)

args を使用すると、カスタム引数を基礎となるコンポーネントに渡すことができます。URL や設定パスなど、一部のパラメーターをオーバーライドする場合に有用です。これらのパラメーターは、エッジのデバッグ時かサポートを受ける場合にのみ有用なものであるため、FlowCollector 記述子の一部として公開しないでください。

env

object (string)

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

port

integer

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

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 を編集することにより、手動で登録できます。

scheduling

object

scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。

affinity

object

指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。

nodeSelector

object (string)

nodeSelector を使用すると、指定した各ラベルを持つノードにのみ Pod をスケジュールできます。ドキュメントについては、https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ を参照してください。

priorityClassName

string

指定した場合、Pod の優先度を示します。ドキュメントについては、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#how-to-use-priority-and-preemption を参照してください。指定されていない場合はデフォルトの優先度が使用され、デフォルトの優先度がない場合は 0 が使用されます。

toleration

array

tolerations は、一致する taint を持つノードに Pod がスケジュールできるようにする toleration のリストです。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。

enable

boolean

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

portNames

object (string)

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

default

boolean

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

filter

object (string)

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

name

string

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

limits

integer-or-string

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

requests

integer-or-string

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

ipfix

object

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

kafka

object

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

type

string

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

targetHost

string

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

targetPort

integer

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

transport

string

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

address

string

Kafka サーバーのアドレス

sasl

object

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

tls

object

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

topic

string

使用する Kafka トピック。これは必ず存在する必要があります。Network Observability はこれを作成しません。

clientIDReference

object

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

clientSecretReference

object

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

type

string

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

file

string

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

name

string

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

namespace

string

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

type

string

ファイル参照のタイプ ("configmap" または "secret")。

file

string

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

name

string

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

namespace

string

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

type

string

ファイル参照のタイプ ("configmap" または "secret")。

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

address

string

Kafka サーバーのアドレス

sasl

object

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

tls

object

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

topic

string

使用する Kafka トピック。これは必ず存在する必要があります。Network Observability はこれを作成しません。

clientIDReference

object

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

clientSecretReference

object

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

type

string

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

file

string

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

name

string

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

namespace

string

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

type

string

ファイル参照のタイプ ("configmap" または "secret")。

file

string

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

name

string

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

namespace

string

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

type

string

ファイル参照のタイプ ("configmap" または "secret")。

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

advanced

object

advanced を使用すると、Loki クライアントの内部設定のいくつかの側面を設定できます。このセクションは、デバッグと詳細なパフォーマンスの最適化を主な目的としています。

enable

boolean

Loki にフローを保存するには、enable を true に設定します。コンソールプラグインは、メトリクスのデータソースとして Loki または Prometheus、またはその両方を使用できます (spec.prometheus.querier も参照してください)。すべてのクエリーを Loki から Prometheus に転送できるわけではありません。したがって、Loki が無効になっている場合、Pod ごとの情報の取得や raw フローの表示など、プラグインの一部の機能も無効になります。Prometheus と Loki の両方が有効になっている場合は、Prometheus が優先され、Prometheus が処理できないクエリーのフォールバックとして Loki が使用されます。両方とも無効になっている場合、コンソールプラグインはデプロイされません。

lokiStack

object

LokiStack モードの Loki 設定。これは、Loki Operator を簡単に設定するのに役立ちます。他のモードでは無視されます。

manual

object

Manual モードの Loki 設定。これは最も柔軟な設定です。他のモードでは無視されます。

microservices

object

Microservices モードの Loki 設定。このオプションは、Loki がマイクロサービスデプロイメントモード (https://grafana.com/docs/loki/latest/fundamentals/architecture/deployment-modes/#microservices-mode) を使用してインストールされている場合に使用します。他のモードでは無視されます。

mode

string

mode は、Loki のインストールモードに応じて設定する必要があります。

- Loki が Loki Operator を使用して管理されている場合は、LokiStack を使用します。

- Loki がモノリシックなワークロードとしてインストールされている場合は、Monolithic を使用します。

- Loki がマイクロサービスとしてインストールされているが、Loki Operator がない場合は、Microservices を使用します。

- 上記のオプションが、いずれもお使いの構成に合わない場合は、Manual を使用します。

monolithic

object

Monolithic モードの Loki 設定。このオプションは、Loki がモノリシックデプロイメントモード (https://grafana.com/docs/loki/latest/fundamentals/architecture/deployment-modes/#monolithic-mode) を使用してインストールされている場合に使用します。他のモードでは無視されます。

readTimeout

string

readTimeout は、コンソールプラグインの loki クエリーの合計時間上限です。タイムアウトがゼロの場合は、タイムアウトしません。

writeBatchSize

integer

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

writeBatchWait

string

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

writeTimeout

string

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

staticLabels

object (string)

staticLabels は、Loki ストレージ内の各フローに設定する共通ラベルのマップです。

writeMaxBackoff

string

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

writeMaxRetries

integer

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

writeMinBackoff

string

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

name

string

使用する既存の LokiStack リソースの名前。

namespace

string

この LokiStack リソースが配置される namespace。省略した場合は、spec.namespace と同じであるとみなされます。

authToken

string

authToken は、Loki に対して認証するためのトークンを取得する方法を示します。

- Disabled の場合、リクエストとともにトークンが送信されません。

- Forward の場合、認可のためにユーザートークンを転送します。

- Host [非推奨 (*)] - ローカル Pod サービスアカウントを使用して Loki に認証します。

Loki Operator を使用する場合、Forward に設定する必要があります。

ingesterUrl

string

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

querierUrl

string

querierUrl は、Loki クエリアーサービスのアドレスを指定します。Loki Operator を使用する場合は、パスに network テナントが設定された Loki ゲートウェイサービスに設定します (例: https://loki-gateway-http.netobserv.svc:8080/api/logs/v1/network)。

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 に設定します。

tls

object

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

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

ingesterUrl

string

ingesterUrl は、フローのプッシュ先となる既存の Loki インジェスターサービスのアドレスです。

querierUrl

string

querierURL は、Loki クエリアーサービスのアドレスを指定します。

tenantID

string

tenantID は、各リクエストのテナントを識別する Loki X-Scope-OrgID ヘッダーです。

tls

object

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

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

tenantID

string

tenantID は、各リクエストのテナントを識別する Loki X-Scope-OrgID ヘッダーです。

tls

object

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

url

string

url は、インジェスターとクエリアーの両方を参照する既存の Loki サービスの一意のアドレスです。

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

addZone

boolean

addZone は、フローに送信元ゾーンと宛先ゾーンのラベルを付けることで、アベイラビリティーゾーンを認識できるようにします。この機能を使用するには、ノードに "topology.kubernetes.io/zone" ラベルを設定する必要があります。

advanced

object

advanced を使用すると、フロープロセッサーの内部設定のいくつかの側面を設定できます。このセクションは、GOGC や GOMAXPROCS 環境変数などのデバッグと詳細なパフォーマンスの最適化を主な目的としています。これらの値はお客様の責任のもと設定してください。

clusterName

string

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

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 は、開始した会話、終了した会話、および定期的な "ティック" 更新のイベントを生成します。

- EndedConversations は、終了した会話イベントのみを生成します。

- All は、ネットワークフローとすべての会話イベントの両方を生成します。

metrics

object

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

multiClusterDeployment

boolean

マルチクラスター機能を有効にするには、multiClusterDeployment を true に設定します。これにより、clusterName ラベルがフローデータに追加されます。

resources

object

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

subnetLabels

object

subnetLabels を使用すると、サブネットと IP にカスタムラベルを定義したり、OpenShift Container Platform で認識されているサブネットの自動ラベル付けを有効にしたりできます。自動ラベル付けは、クラスターの外部トラフィックを識別するために使用されます。サブネットがフローの送信元 IP または宛先 IP と一致する場合、対応するフィールド SrcSubnetLabel または DstSubnetLabel が追加されます。

conversationEndTimeout

string

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

conversationHeartbeatInterval

string

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

conversationTerminatingTimeout

string

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

dropUnusedFields

boolean

dropUnusedFields [非推奨 (*)] この設定は、現在使用されていません。

enableKubeProbes

boolean

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

env

object (string)

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

healthPort

integer

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

port

integer

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

profilePort

integer

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

scheduling

object

scheduling は、Pod がノードでどのようにスケジュールされるかを制御します。

affinity

object

指定した場合、Pod のスケジューリング制約。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。

nodeSelector

object (string)

nodeSelector を使用すると、指定した各ラベルを持つノードにのみ Pod をスケジュールできます。ドキュメントについては、https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ を参照してください。

priorityClassName

string

指定した場合、Pod の優先度を示します。ドキュメントについては、https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#how-to-use-priority-and-preemption を参照してください。指定されていない場合はデフォルトの優先度が使用され、デフォルトの優先度がない場合は 0 が使用されます。

toleration

array

tolerations は、一致する taint を持つノードに Pod がスケジュールできるようにする toleration のリストです。ドキュメントについては、https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling を参照してください。

disableAlerts

array (string)

disableAlerts は、無効にする必要があるアラートのリストです。可能な値は次のとおりです。

NetObservNoFlows は、一定期間フローが観測されない場合にトリガーされます。

NetObservLokiError: Loki エラーが原因でフローがドロップされるとトリガーされます。

includeList

array (string)

includeList は、生成するメトリクスを指定するためのメトリクス名のリストです。名前は、接頭辞を除いた Prometheus の名前に対応します。たとえば、namespace_egress_packets_total は、Prometheus では netobserv_namespace_egress_packets_total と表示されます。メトリクスを追加するほど、Prometheus ワークロードリソースへの影響が大きくなることに注意してください。デフォルトで有効なメトリクスは、namespace_flows_total、node_ingress_bytes_total、workload_ingress_bytes_total、namespace_drop_packets_total (PacketDrop 機能が有効な場合)、namespace_rtt_seconds (FlowRTT 機能が有効な場合)、namespace_dns_latency_seconds (DNSTracking 機能が有効な場合) です。利用可能なメトリクスの完全なリストを含む詳細情報は、https://github.com/netobserv/network-observability-operator/blob/main/docs/Metrics.md を参照してください。

server

object

Prometheus スクレイパーのメトリクスサーバーエンドポイント設定

port

integer

メトリクスサーバーの HTTP ポート。

tls

object

TLS 設定。

insecureSkipVerify

boolean

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

provided

object

type が Provided に設定されている場合の TLS 設定。

providedCaFile

object

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

type

string

TLS 設定のタイプを選択します。

- Disabled (デフォルト) は、エンドポイントに TLS を設定しません。- Provided は、証明書ファイルとキーファイルを手動で指定します [サポート対象外 (*)]。- Auto は、アノテーションを使用して OpenShift Container Platform の自動生成証明書を使用します。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

file

string

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

name

string

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

namespace

string

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

type

string

ファイル参照のタイプ ("configmap" または "secret")。

limits

integer-or-string

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

requests

integer-or-string

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

customLabels

array

customLabels を使用すると、クラスター外部のワークロードや Web サービスの識別などのために、サブネットと IP のラベル付けをカスタマイズできます。openShiftAutoDetect を有効にすると、検出されたサブネットがオーバーラップしている場合に、customLabels がそのサブネットをオーバーライドできます。

openShiftAutoDetect

boolean

openShiftAutoDetect を true に設定すると、OpenShift Container Platform のインストール設定と Cluster Network Operator の設定に基づいて、マシン、Pod、およびサービスのサブネットを自動的に検出できます。これは間接的に外部トラフィックを正確に検出する方法です。つまり、これらのサブネットのラベルが付いていないフローは、クラスターの外部のものです。OpenShift Container Platform ではデフォルトで有効になっています。

cidrs

array (string)

["1.2.3.4/32"] などの CIDR のリスト。

name

string

一致するフローにフラグを設定するために使用するラベル名。

querier

object

コンソールプラグインで使用される、クライアント設定などの Prometheus クエリー設定。

enable

boolean

enable が true の場合、コンソールプラグインは、可能な場合は常に、Loki ではなく Prometheus からフローメトリクスをクエリーします。デフォルトでは有効になっています。この機能を無効にするには false に設定します。コンソールプラグインは、メトリクスのデータソースとして Loki または Prometheus、またはその両方を使用できます (spec.loki も参照してください)。すべてのクエリーを Loki から Prometheus に転送できるわけではありません。したがって、Loki が無効になっている場合、Pod ごとの情報の取得や raw フローの表示など、プラグインの一部の機能も無効になります。Prometheus と Loki の両方が有効になっている場合は、Prometheus が優先され、Prometheus が処理できないクエリーのフォールバックとして Loki が使用されます。両方とも無効になっている場合、コンソールプラグインはデプロイされません。

manual

object

Manual モードの Prometheus 設定。

mode

string

mode は、Network Observability メトリクスを保存する Prometheus インストールのタイプに応じて設定する必要があります。

- 自動設定を試行するには、Auto を使用します。OpenShift Container Platform では、OpenShift Container Platform クラスターモニタリングの Thanos クエリーを使用します。

- 手動設定の場合は、Manual を使用します。

timeout

string

timeout は、Prometheus へのコンソールプラグインクエリーの読み取りタイムアウトです。タイムアウトがゼロの場合は、タイムアウトしません。

forwardUserToken

boolean

ログインしたユーザートークンをクエリーで Prometheus に転送するには、true に設定します。

tls

object

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

url

string

url は、メトリクスのクエリーに使用する既存の Prometheus サービスのアドレスです。

caCert

object

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

enable

boolean

TLS を有効にします。

insecureSkipVerify

boolean

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

userCert

object

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

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。

certFile

string

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

certKey

string

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

name

string

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

namespace

string

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

type

string

証明書参照のタイプ (configmap または secret)。