Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 28 additions & 29 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2559,6 +2559,34 @@ Topics:
File: otel-updating
- Name: Removal
File: otel-removing
- Name: Network Observability
Dir: network_observability
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Network Observability release notes
File: network-observability-operator-release-notes
- Name: Network Observability overview
File: network-observability-overview
- Name: Installing the Network Observability Operator
File: installing-operators
- Name: Understanding Network Observability Operator
File: understanding-network-observability-operator
- Name: Configuring the Network Observability Operator
File: configuring-operator
- Name: Network Policy
File: network-observability-network-policy
- Name: Observing the network traffic
File: observing-network-traffic
- Name: Using metrics with dashboards and alerts
File: metrics-alerts-dashboards
- Name: Monitoring the Network Observability Operator
File: network-observability-operator-monitoring
- Name: API reference
File: flowcollector-api
- Name: JSON flows format reference
File: json-flows-format-reference
- Name: Troubleshooting Network Observability
File: troubleshooting-network-observability
---
Name: Logging
Dir: logging
Expand Down Expand Up @@ -2714,35 +2742,6 @@ Topics:
- Name: Configuring the Cluster Observability Operator to monitor a service
File: configuring-the-cluster-observability-operator-to-monitor-a-service
---
Name: Network Observability
Dir: network_observability
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Network Observability release notes
File: network-observability-operator-release-notes
- Name: Network Observability overview
File: network-observability-overview
- Name: Installing the Network Observability Operator
File: installing-operators
- Name: Understanding Network Observability Operator
File: understanding-network-observability-operator
- Name: Configuring the Network Observability Operator
File: configuring-operator
- Name: Network Policy
File: network-observability-network-policy
- Name: Observing the network traffic
File: observing-network-traffic
- Name: Using metrics with dashboards and alerts
File: metrics-alerts-dashboards
- Name: Monitoring the Network Observability Operator
File: network-observability-operator-monitoring
- Name: API reference
File: flowcollector-api
- Name: JSON flows format reference
File: json-flows-format-reference
- Name: Troubleshooting Network Observability
File: troubleshooting-network-observability
---
Name: Scalability and performance
Dir: scalability_and_performance
Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu
Expand Down
67 changes: 0 additions & 67 deletions network_observability/installing-operators.adoc

This file was deleted.

2 changes: 1 addition & 1 deletion networking/networking-operators-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ The Ingress Node Firewall Operator uses an extended Berkley Packet Filter (eBPF)

[id="network-observability-operator-overview-operator"]
== Network Observability Operator
The Network Observability Operator is an optional Operator that allows cluster administrators to observe the network traffic for {product-title} clusters. The Network Observability Operator uses the eBPF technology to create network flows. The network flows are then enriched with {product-title} information and stored in Loki. You can view and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting. For more information, see xref:../network_observability/network-observability-overview.adoc#dependency-network-observability[About Network Observability Operator].
The Network Observability Operator is an optional Operator that allows cluster administrators to observe the network traffic for {product-title} clusters. The Network Observability Operator uses the eBPF technology to create network flows. The network flows are then enriched with {product-title} information and stored in Loki. You can view and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting. For more information, see xref:../observability/network_observability/network-observability-overview.adoc#dependency-network-observability[About Network Observability Operator].
3 changes: 1 addition & 2 deletions observability/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,5 @@ For more information, see xref:otel/otel-installing.adoc#install-otel[{OTELName}
== Network Observability
Observe the network traffic for {product-title} clusters and create network flows with the Network Observability Operator. View and analyze the stored network flows information in the {product-title} console for further insight and troubleshooting.

For more information, see xref:../network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
//after the file is added to the observability directory, update xref path to ../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
For more information, see xref:../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].

Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ include::modules/network-observability-flowcollector-view.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
For more information about conversation tracking, see xref:../network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversations].
For more information about conversation tracking, see xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversations].

include::modules/network-observability-flowcollector-kafka-config.adoc[leveloffset=+1]
include::modules/network-observability-enriched-flows.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
For more information about specifying flow format, see xref:../network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network flows format reference].
For more information about specifying flow format, see xref:../../observability/network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network flows format reference].

include::modules/network-observability-configuring-FLP-sampling.adoc[leveloffset=+1]
include::modules/network-observability-configuring-quickfilters-flowcollector.adoc[leveloffset=+1]
include::modules/network-observability-SRIOV-configuration.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
For more information about creating the `SriovNetwork` custom resource, see xref:../networking/hardware_networks/configuring-sriov-device.adoc#cnf-creating-an-additional-sriov-network-with-vrf-plug-in_configuring-sriov-device[Creating an additional SR-IOV network attachment with the CNI VRF plugin].
For more information about creating the `SriovNetwork` custom resource, see xref:../../networking/hardware_networks/configuring-sriov-device.adoc#cnf-creating-an-additional-sriov-network-with-vrf-plug-in_configuring-sriov-device[Creating an additional SR-IOV network attachment with the CNI VRF plugin].

include::modules/network-observability-resource-recommendations.adoc[leveloffset=+1]
include::modules/network-observability-resources-table.adoc[leveloffset=+2]
67 changes: 67 additions & 0 deletions observability/network_observability/installing-operators.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
:_mod-docs-content-type: ASSEMBLY
[id="installing-network-observability-operators"]
= Installing the Network Observability Operator
include::_attributes/common-attributes.adoc[]
:context: network_observability

toc::[]
Installing Loki is a recommended prerequisite for using the Network Observability Operator. You can choose to use xref:../../observability/network_observability/installing-operators.adoc#network-observability-without-loki_network_observability[Network Observability without Loki], but there are some considerations for doing this, described in the previously linked section.

The {loki-op} integrates a gateway that implements multi-tenancy and authentication with Loki for data flow storage. The `LokiStack` resource manages Loki, which is a scalable, highly-available, multi-tenant log aggregation system, and a web proxy with {product-title} authentication. The `LokiStack` proxy uses {product-title} authentication to enforce multi-tenancy and facilitate the saving and indexing of data in Loki log stores.

[NOTE]
====
The {loki-op} can also be used for xref:../../logging/log_storage/cluster-logging-loki.adoc#cluster-logging-loki[configuring the LokiStack log store]. The Network Observability Operator requires a dedicated LokiStack separate from the {logging}.
====

include::modules/network-observability-without-loki.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-enriched-flows_network_observability[Export enriched network flow data].

include::modules/network-observability-loki-install.adoc[leveloffset=+1]
include::modules/network-observability-loki-secret.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource]
* xref:../../logging/log_storage/installing-log-storage.adoc#logging-loki-storage_installing-log-storage[Loki object storage]

include::modules/network-observability-lokistack-create.adoc[leveloffset=+2]
include::modules/logging-creating-new-group-cluster-admin-user-role.adoc[leveloffset=+2]
include::modules/logging-loki-log-access.adoc[leveloffset=+1,tags=CustomAdmin;NetObservMode;!LokiMode]
include::modules/loki-deployment-sizing.adoc[leveloffset=+2]
include::modules/network-observability-lokistack-ingestion-query.adoc[leveloffset=+2]
include::modules/network-observability-multitenancy.adoc[leveloffset=+2]
include::modules/network-observability-operator-install.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_configuring-flow-collector-considerations"]
== Important Flow Collector configuration considerations
Once you create the `FlowCollector` instance, you can reconfigure it, but the pods are terminated and recreated again, which can be disruptive. Therefore, you can consider configuring the following options when creating the `FlowCollector` for the first time:

* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the Flow Collector resource with Kafka]
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-enriched-flows_network_observability[Export enriched network flow data to Kafka or IPFIX]
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-SR-IOV-config_network_observability[Configuring monitoring for SR-IOV interface traffic]
* xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-working-with-conversations_nw-observe-network-traffic[Working with conversation tracking]
* xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-dns-tracking_nw-observe-network-traffic[Working with DNS tracking]
* xref:../../observability/network_observability/observing-network-traffic.adoc#network-observability-packet-drops_nw-observe-network-traffic[Working with packet drops]

[role="_additional-resources"]
.Additional resources
For more general information about Flow Collector specifications and the Network Observability Operator architecture and resource use, see the following resources:

* xref:../../observability/network_observability/flowcollector-api.adoc#network-observability-flowcollector-api-specifications_network_observability[Flow Collector API Reference]
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-view_network_observability[Flow Collector sample resource]
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-resources-table_network_observability[Resource considerations]
* xref:../../observability/network_observability/troubleshooting-network-observability.adoc#controller-manager-pod-runs-out-of-memory_network-observability-troubleshooting[Troubleshooting Network Observability controller manager pod runs out of memory]
* xref:../../observability/network_observability/understanding-network-observability-operator.adoc#network-observability-architecture_nw-network-observability-operator[Network Observability architecture]


include::modules/network-observability-kafka-option.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the FlowCollector resource with Kafka].

include::modules/network-observability-operator-uninstall.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ include::modules/network-observability-includelist-example.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* For more information about creating alerts that you can see on the dashboard, see xref:../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alerting rules for user-defined projects].
* For more information about creating alerts that you can see on the dashboard, see xref:../../monitoring/managing-alerts.adoc#creating-alerting-rules-for-user-defined-projects_managing-alerts[Creating alerting rules for user-defined projects].
Loading