Skip to content

Commit 47c0d82

Browse files
committed
OSDOCS-18730 [NETOBSERV] Fix new Vale rule: ConceptLink
1 parent edcd85a commit 47c0d82

11 files changed

Lines changed: 27 additions & 15 deletions

modules/network-observability-creating-metrics-network-events.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,8 @@ where:
6161
.Verification
6262
. In the web console, navigate to *Observe* -> *Dashboards* and scroll down to see the *Network Policy* tab.
6363
. You should begin seeing metrics filter in based on the metric you created along with the network policy specifications.
64+
65+
[IMPORTANT]
66+
====
67+
High cardinality can affect the memory usage of Prometheus. You can check if specific labels have high cardinality in the network flows format. See "Network Flows format reference".
68+
====

modules/network-observability-health-rules-monitoring-and-alerting.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
//
33
// * network_observability/network-observability-health-rules.adoc
44

5-
:_mod-docs-content-type: CONCEPT
5+
:_mod-docs-content-type: REFERENCE
66
[id="network-observability-health-rules-monitoring-and-alerting_{context}"]
77
= Network health monitoring and alerting rules
88

@@ -47,4 +47,4 @@ For a complete list of rules and runbooks, see the link:https://github.com/opens
4747
== Rule dependencies and feature requirements
4848
The Network Observability Operator creates rules based on the features enabled in the `FlowCollector` custom resource (CR).
4949

50-
For example, packet drop-related rules are created only if the `PacketDrop` agent feature is enabled. Rules are built on metrics; if the required metrics are missing, configuration warnings might appear. Configure metrics in the `spec.processor.metrics.includeList` object of the `FlowCollector` resource.
50+
For example, packet drop-related rules are created only if the `PacketDrop` agent feature is enabled. Rules are built on metrics; if the required metrics are missing, configuration warnings might appear. Configure metrics in the `spec.processor.metrics.includeList` object of the `FlowCollector` resource.

modules/network-observability-important-flowcollector-considerations.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
// Module included in the following assemblies:
22
//
3-
// network_observability/installing-operators.adoc
3+
// * network_observability/installing-operators.adoc
44

55
:_mod-docs-content-type: REFERENCE
6-
[id="additional-resources_configuring-flow-collector-considerations_{context}"]
7-
= Important Flow Collector configuration considerations
6+
[id="network-observability-important-flowcollector-configuration-considerations_{context}"]
7+
= Important FlowCollector configuration considerations
88

99
[role="_abstract"]
1010
Review essential `FlowCollector` configuration options before initial deployment to avoid pod disruptions caused by later reconfiguration. Key settings include Kafka integration, enriched flow data exports, SR-IOV traffic monitoring, and advanced tracking for DNS and packet drops.
1111

12-
When you create the `FlowCollector` instance, you can reconfigure it, but the pods are terminated and recreated again, which can be disruptive.
12+
Once you create the `FlowCollector` instance, you can reconfigure it, but the pods are terminated and recreated again, which can be disruptive.
1313

1414
Therefore, you can consider configuring the following options when creating the `FlowCollector` for the first time.
1515

modules/network-observability-kafka-option.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[role="_abstract"]
1010
The Kafka Operator is supported for large-scale environments. Kafka provides high-throughput and low-latency data feeds for forwarding network flow data in a more resilient, scalable way.
1111

12-
You can install the Kafka Operator as link:https://access.redhat.com/documentation/en-us/red_hat_amq_streams/2.2[Red Hat AMQ Streams] from the Operator Hub, just as the {loki-op} and Network Observability Operator were installed. Refer to "Configuring the FlowCollector resource with Kafka" to configure Kafka as a storage option.
12+
You can install the Kafka Operator as Red Hat AMQ Streams from the Operator Hub, just as the {loki-op} and Network Observability Operator were installed. Refer to "Configuring the FlowCollector resource with Kafka" to configure Kafka as a storage option.
1313

1414
[NOTE]
1515
====

modules/network-observability-lokistack-ingestion-query.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// Module included in the following assemblies:
22

33
// * networking/network_observability/installing-operators.adoc
4-
:_mod-docs-content-type: CONCEPT
4+
:_mod-docs-content-type: REFERENCE
55
[id="network-observability-lokistack-configuring-ingestion_{context}"]
66
= LokiStack ingestion limits and health alerts
77

modules/network-observability-packet-translation-overview.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,4 @@ As network packets are processed, the eBPF hook enriches flow logs with metadata
2222
- Source Port
2323
- Destination Pod IP
2424
- Destination Port
25-
- link:https://lwn.net/Articles/370152/#:~:text=A%20zone%20is%20simply%20a,to%20seperate%20conntrack%20defragmentation%20queues.[Conntrack Zone ID]
26-
25+
- Conntrack Zone ID

observability/network_observability/installing-operators.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,7 @@ include::modules/network-observability-lokistack-ingestion-query.adoc[leveloffse
4747

4848
include::modules/network-observability-operator-install.adoc[leveloffset=+1]
4949

50-
include::modules/network-observability-multitenancy.adoc[leveloffset=+1]
51-
52-
include::modules/network-observability-important-flowcollector-considerations.adoc[leveloffset=+1]
50+
include::modules/network-observability-important-flowcollector-considerations.adoc[leveloffset=+2]
5351

5452
[role="_additional-resources"]
5553
.Additional resources
@@ -65,6 +63,8 @@ include::modules/network-observability-important-flowcollector-considerations.ad
6563
* 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]
6664
* xref:../../observability/network_observability/understanding-network-observability-operator.adoc#network-observability-architecture_nw-network-observability-operator[Network observability architecture]
6765
66+
include::modules/network-observability-multitenancy.adoc[leveloffset=+1]
67+
6868
include::modules/network-observability-updating-migrating.adoc[leveloffset=+2]
6969

7070
[role="_additional-resources"]
@@ -75,6 +75,7 @@ include::modules/network-observability-kafka-option.adoc[leveloffset=+1]
7575

7676
[role="_additional-resources"]
7777
.Additional resources
78+
* link:https://docs.redhat.com/en/documentation/red_hat_streams_for_apache_kafka/2.2[Red Hat AMQ Streams]
7879
* xref:../../observability/network_observability/configuring-operator.adoc#network-observability-flowcollector-kafka-config_network_observability[Configuring the FlowCollector resource with Kafka]
7980
8081
include::modules/network-observability-operator-uninstall.adoc[leveloffset=+1]

observability/network_observability/metrics-alerts-dashboards.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ include::modules/network-observability-configuring-custom-metrics-examples.adoc[
2525

2626
include::modules/network-observability-creating-metrics-network-events.adoc[leveloffset=+1]
2727

28+
[role="_additional-resources"]
29+
.Additional resources
30+
* xref:../../observability/network_observability/json-flows-format-reference.adoc#network-observability-flows-format_json_reference[Network Flows format reference]
31+
2832
include::modules/network-observability-flowmetrics-charts.adoc[leveloffset=+1]
2933

3034
include::modules/network-observability-flowmetrics-charts-examples.adoc[leveloffset=+2]

observability/network_observability/network-observability-health-rules.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ include::modules/network-observability-custom-health-rule-configuration.adoc[lev
3030

3131
include::modules/network-observability-disable-predefined-rules.adoc[leveloffset=+1]
3232

33-
3433
[role="_additional-resources"]
3534
== Additional resources
3635
* xref:../../observability/network_observability/network-observability-health-rules.adoc#network-observability-default-rules_network-observability-health-rules[List of default rules]

observability/network_observability/network-observability-operator-release-notes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ include::_attributes/common-attributes.adoc[]
88
toc::[]
99

1010
[role="_abstract"]
11-
Review new features, enhancements, fixed issues, and known issues for the Network Observability Operator. These release notes provide information to help you understand changes and security advisories in the latest operator release.
11+
Find information about new features, security advisories, fixed issues, and known issues for the Network Observability Operator. Use these notes to stay informed about changes and performance enhancements in the latest version of the operator for {product-title}.
1212

1313
The Network Observability Operator enables administrators to observe and analyze network traffic flows for {product-title} clusters.
1414

0 commit comments

Comments
 (0)