Skip to content

Commit 10491e4

Browse files
authored
Merge pull request #73554 from skrthomas/OBSDOCS-695
OBSDOCS-695:Update Network Observability doc links and topic map posi…
2 parents 7d4473d + 95d7fa8 commit 10491e4

22 files changed

+133
-136
lines changed

_topic_maps/_topic_map.yml

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2668,6 +2668,34 @@ Topics:
26682668
File: otel-updating
26692669
- Name: Removal
26702670
File: otel-removing
2671+
- Name: Network Observability
2672+
Dir: network_observability
2673+
Distros: openshift-enterprise,openshift-origin
2674+
Topics:
2675+
- Name: Network Observability release notes
2676+
File: network-observability-operator-release-notes
2677+
- Name: Network Observability overview
2678+
File: network-observability-overview
2679+
- Name: Installing the Network Observability Operator
2680+
File: installing-operators
2681+
- Name: Understanding Network Observability Operator
2682+
File: understanding-network-observability-operator
2683+
- Name: Configuring the Network Observability Operator
2684+
File: configuring-operator
2685+
- Name: Network Policy
2686+
File: network-observability-network-policy
2687+
- Name: Observing the network traffic
2688+
File: observing-network-traffic
2689+
- Name: Using metrics with dashboards and alerts
2690+
File: metrics-alerts-dashboards
2691+
- Name: Monitoring the Network Observability Operator
2692+
File: network-observability-operator-monitoring
2693+
- Name: API reference
2694+
File: flowcollector-api
2695+
- Name: JSON flows format reference
2696+
File: json-flows-format-reference
2697+
- Name: Troubleshooting Network Observability
2698+
File: troubleshooting-network-observability
26712699
- Name: Power Monitoring
26722700
Dir: power_monitoring
26732701
Distros: openshift-enterprise,openshift-origin
@@ -2837,35 +2865,6 @@ Topics:
28372865
- Name: Configuring the Cluster Observability Operator to monitor a service
28382866
File: configuring-the-cluster-observability-operator-to-monitor-a-service
28392867
---
2840-
Name: Network Observability
2841-
Dir: network_observability
2842-
Distros: openshift-enterprise,openshift-origin
2843-
Topics:
2844-
- Name: Network Observability release notes
2845-
File: network-observability-operator-release-notes
2846-
- Name: Network Observability overview
2847-
File: network-observability-overview
2848-
- Name: Installing the Network Observability Operator
2849-
File: installing-operators
2850-
- Name: Understanding Network Observability Operator
2851-
File: understanding-network-observability-operator
2852-
- Name: Configuring the Network Observability Operator
2853-
File: configuring-operator
2854-
- Name: Network Policy
2855-
File: network-observability-network-policy
2856-
- Name: Observing the network traffic
2857-
File: observing-network-traffic
2858-
- Name: Using metrics with dashboards and alerts
2859-
File: metrics-alerts-dashboards
2860-
- Name: Monitoring the Network Observability Operator
2861-
File: network-observability-operator-monitoring
2862-
- Name: API reference
2863-
File: flowcollector-api
2864-
- Name: JSON flows format reference
2865-
File: json-flows-format-reference
2866-
- Name: Troubleshooting Network Observability
2867-
File: troubleshooting-network-observability
2868-
---
28692868
Name: Scalability and performance
28702869
Dir: scalability_and_performance
28712870
Distros: openshift-origin,openshift-enterprise,openshift-webscale,openshift-dpu

network_observability/installing-operators.adoc

Lines changed: 0 additions & 67 deletions
This file was deleted.

networking/networking-dashboards.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Networking metrics are viewable in dashboards within the {product-title} web con
1010

1111
[id="network-observability-operator-operator-dashboards"]
1212
== Network Observability Operator
13-
If you have the Network Observability Operator installed, you can view network traffic metrics dashboards by selecting the *Netobserv* dashboard from the *Dashboards* drop-down list. For more information about metrics available in this *Dashboard*, see xref:../network_observability/metrics-alerts-dashboards.adoc#network-observability-viewing-dashboards_metrics-dashboards-alerts[Network Observability metrics dashboards]
13+
If you have the Network Observability Operator installed, you can view network traffic metrics dashboards by selecting the *Netobserv* dashboard from the *Dashboards* drop-down list. For more information about metrics available in this *Dashboard*, see xref:../observability/network_observability/metrics-alerts-dashboards.adoc#network-observability-viewing-dashboards_metrics-dashboards-alerts[Network Observability metrics dashboards].
1414

1515
[id="general-networking-ovnk-dashboards"]
1616
== Networking and OVN-Kubernetes dashboard

networking/networking-operators-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ The Ingress Node Firewall Operator uses an extended Berkley Packet Filter (eBPF)
3030

3131
[id="network-observability-operator-overview-operator"]
3232
== Network Observability Operator
33-
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].
33+
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].

observability/index.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ For more information, see xref:otel/otel-installing.adoc#install-otel[{OTELName}
5252
== Network Observability
5353
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.
5454

55-
For more information, see xref:../network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
56-
//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].
55+
For more information, see xref:../observability/network_observability/network-observability-overview.adoc#network-observability-overview[Network Observability overview].
5756

5857
[id="power-monitoring-overview-index"]
5958
== Power monitoring

network_observability/configuring-operator.adoc renamed to observability/network_observability/configuring-operator.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ include::modules/network-observability-flowcollector-view.adoc[leveloffset=+1]
1313

1414
[role="_additional-resources"]
1515
.Additional resources
16-
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].
16+
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].
1717

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

2121
[role="_additional-resources"]
2222
.Additional resources
23-
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].
23+
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].
2424

2525
include::modules/network-observability-configuring-FLP-sampling.adoc[leveloffset=+1]
2626
include::modules/network-observability-configuring-quickfilters-flowcollector.adoc[leveloffset=+1]
2727
include::modules/network-observability-SRIOV-configuration.adoc[leveloffset=+1]
2828
[role="_additional-resources"]
2929
.Additional resources
30-
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].
30+
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].
3131
3232
include::modules/network-observability-resource-recommendations.adoc[leveloffset=+1]
3333
include::modules/network-observability-resources-table.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)