Skip to content
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

docs: Add IPFIX docs #12078

Merged
merged 1 commit into from Mar 11, 2022
Merged

docs: Add IPFIX docs #12078

merged 1 commit into from Mar 11, 2022

Conversation

koolzz
Copy link
Contributor

@koolzz koolzz commented Mar 11, 2022

Signed-off-by: Nick Yurchenko koolzz@fb.com

Summary

  • Add IPFIX documentation

Test Plan

Additional Information

  • This change is backwards-breaking

@pull-request-size pull-request-size bot added the size/L Denotes a Pull Request that changes 100-499 lines. label Mar 11, 2022
@github-actions
Copy link
Contributor

Thanks for opening a PR! 💯

A couple initial guidelines

Howto

  • Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
  • Checks. All required CI checks must pass before merge.
  • Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

If this is your first Magma PR, also consider reading

@github-actions github-actions bot added the component: docs Documentation-related issue label Mar 11, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2022

Oops! Looks like you failed the Semantic PR check.

Howto

♻️ Updated: ✅ The check is passing the Semantic PR after the last commit.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 11, 2022

Oops! Looks like you failed the Markdown lint check.

Howto

♻️ Updated: ✅ The check is passing the Markdown lint check after the last commit.

@koolzz koolzz force-pushed the ipfix_doc branch 2 times, most recently from 0af3d0f to 6f04d31 Compare March 11, 2022 04:02
@koolzz koolzz marked this pull request as ready for review March 11, 2022 04:03
@koolzz koolzz requested review from a team and electronjoe March 11, 2022 04:03
Copy link
Contributor

@pshelar pshelar left a comment

Choose a reason for hiding this comment

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

LTGM

This is done by leveraging the linux conntrack events via the ConntrackD service and generating an internal packet every time a conntrack event is generated.
The internal packet is recognized by the OVS flowtable as a special packet, gets forwarded to a specific IPFIX sampling table, hits the sampling rule(creating the IPFIX entry), and is then dropped.

## Default mode
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you mention advantage on typical setup with contract-mode.

@koolzz koolzz force-pushed the ipfix_doc branch 3 times, most recently from 5ac2036 to 5520f42 Compare March 11, 2022 04:13
@koolzz koolzz changed the title Add IPFIX docs docs(agw): Add IPFIX docs Mar 11, 2022
@koolzz koolzz changed the title docs(agw): Add IPFIX docs docs: Add IPFIX docs Mar 11, 2022
@themarwhal
Copy link
Member

is this meant to be visible through docusaurus?

@koolzz
Copy link
Contributor Author

koolzz commented Mar 11, 2022

is this meant to be visible through docusaurus?

Sure why not, do I need to run some docusaurus gen?

@themarwhal
Copy link
Member

is this meant to be visible through docusaurus?

Sure why not, do I need to run some docusaurus gen?

Ya you just have to add an entry here: docs/docusaurus/sidebars.json
and then make -C $MAGMA_ROOT/docs to generate some files

@koolzz koolzz force-pushed the ipfix_doc branch 2 times, most recently from ba12408 to d6fa07f Compare March 11, 2022 15:42
Signed-off-by: Nick Yurchenko <koolzz@fb.com>
@koolzz koolzz merged commit 4e917d3 into magma:master Mar 11, 2022
ardzoht pushed a commit that referenced this pull request Mar 30, 2022
Signed-off-by: Nick Yurchenko <koolzz@fb.com>
emakeev pushed a commit to emakeev/magma that referenced this pull request Aug 5, 2022
Signed-off-by: Nick Yurchenko <koolzz@fb.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: docs Documentation-related issue size/L Denotes a Pull Request that changes 100-499 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants