Skip to content

Refresh archicture doc#1022

Merged
jotak merged 5 commits intonetobserv:mainfrom
jotak:architecture
Jan 20, 2025
Merged

Refresh archicture doc#1022
jotak merged 5 commits intonetobserv:mainfrom
jotak:architecture

Conversation

@jotak
Copy link
Member

@jotak jotak commented Jan 17, 2025

This doc is very old and needs a refresh!

I'd move to mermaid charts, like what we have in the agent, which makes it easier to update.


## CLI

When using the CLI, the operator is not involved, which means you can use it without installing NetObserv as a whole. It uses a special mode of the eBPF agents that embeds FLP.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes sounds good. Note that the collector is not involved for the metrics generation. That could be mentionned too

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When using the CLI, the operator is not involved, which means you can use it without installing NetObserv as a whole. It uses a special mode of the eBPF agents that embeds FLP.
When using the CLI, the operator is not involved, which means you can use it without installing NetObserv as a whole. It uses a special mode of the eBPF agents that embeds FLP.
Flows and Packets captures will deploy both agents and collector.
Metrics captures will only deploy agents.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe that's something I missed .. how does metrics work when using the kubectl plugin ? The readme mentions only a make target for capturing metrics. If I run oc netobserv flows ... can I get metrics as well?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nvm I've checked the PR, it's explained: $ ./build/oc-netobserv metrics --enable_pktdrop="true" --enable_dns="true" --enable_rtt="true"

next question: README says that's only for openshift, but what if I have prometheus without openshift? I guess I can still have the metrics, it's just the charts that I won't get, correct?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added details in last commit c51d0d7

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes if you have a ServiceMonitor you will have the metrics
But the configmap in openshift namespace will be ignored


- An [eBPF agent](https://github.com/netobserv/netobserv-ebpf-agent), that generates network flows from captured packets.
- It is attached to any/all of the network interfaces in the host, and listens for packets (ingress+egress) with [eBPF](https://ebpf.io/).
- Packets are aggregated into logical flows (similar to NetFlows), periodically exported to a collector, generally FLP.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention the packet capture here ?
That may come in the operator too in the future

jotak and others added 3 commits January 17, 2025 16:17
Co-authored-by: Julien Pinsonneau <91894519+jpinsonneau@users.noreply.github.com>
Co-authored-by: Julien Pinsonneau <91894519+jpinsonneau@users.noreply.github.com>
@jotak jotak requested a review from jpinsonneau January 17, 2025 15:49
@jotak
Copy link
Member Author

jotak commented Jan 20, 2025

/approve

@openshift-ci
Copy link

openshift-ci bot commented Jan 20, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jotak

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jotak jotak merged commit e4ea8aa into netobserv:main Jan 20, 2025
8 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants