-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-11625:Viewing Network events in Network Observability #80846
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// Module included in the following assemblies: | ||
// | ||
// * network_observability/observing-network-traffic.adoc | ||
|
||
:_mod-docs-content-type: PROCEDURE | ||
[id="network-observability-viewing-network-events_{context}"] | ||
= Viewing network events | ||
You can view network events, such as network flows that are dropped or allowed by a network policy, by editing the `FlowCollector` to the specifications in the following YAML example. | ||
|
||
.Prerequisites | ||
* Must have the `OVNObservability` specified in the `FeatureGate` custom resource. For more information, see "Enabling features using feature gates" in the "Additional resources" of this section. | ||
|
||
.Procedure | ||
. In the web console, navigate to *Operators* -> *Installed Operators*. | ||
. In the *Provided APIs* heading for the *NetObserv Operator*, select *Flow Collector*. | ||
. Select *cluster*, and then select the *YAML* tab. | ||
. Configure the `FlowCollector` custom resource to enable viewing `NetworkEvents`, for example: | ||
+ | ||
[id="network-observability-flowcollector-configuring-networkevents{context}"] | ||
.Example `FlowCollector` configuration | ||
[source, yaml] | ||
---- | ||
apiVersion: flows.netobserv.io/v1beta2 | ||
kind: FlowCollector | ||
metadata: | ||
name: cluster | ||
spec: | ||
agent: | ||
type: eBPF | ||
ebpf: | ||
privileged: true | ||
features: | ||
- "NetworkEvents" | ||
---- | ||
|
||
.Verification | ||
. Navigate to the *Network Traffic* view and select the *Traffic flows* table. | ||
. You should see the new column, *Network Events*, where you can view information about impacts that network policies, admin policies, and egress firewalls have on network flows. | ||
+ | ||
.Examples of Network Events output | ||
[source,text] | ||
---- | ||
Dropped by cluster multicast policy, direction Ingress | ||
---- | ||
+ | ||
[source,text] | ||
---- | ||
Allowed by network policy iperf.iperf3-server-access-egress, direction Egress | ||
---- | ||
+ | ||
[source,text] | ||
---- | ||
Allowed by admin network policy allow-egress-iperf, direction Egress | ||
---- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be great to add example of output messages here
cc @msherif1234
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion, @jpinsonneau Do you mean an example of what's printed in the cell of the Network Events column? Or another kind of output message?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes example of informations this column can provide since it cover tons of different cases
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jpinsonneau awesome, thanks for the idea. I added these based on a screencapture that @msherif1234 provided of the column in the console. https://github.com/openshift/openshift-docs/pull/80846/files#diff-2c58e02f3f3d88ed7f2bea54b85dd8efb8d183028d9c8ba19f0721704f933109R39-R54
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@msherif1234 do we have a full list of these ?
I only found https://github.com/ovn-org/ovn-kubernetes/pull/4596/files#diff-f3bfaffd193f40c714d0dd4f96636c614bd73cd4d1c12cbcd1ebdc31e4041e56R161 and the related tech doc https://github.com/ovn-org/ovn-kubernetes/pull/4596/files#diff-2ec9b512514bf19c87313b7da12c9436f73d963ece18048a4372b6af918124ca mentionning:
That could be added too ?