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

Update Submariner OVN Documentation #699

Merged
merged 1 commit into from
Jun 21, 2022

Conversation

astoycos
Copy link
Contributor

@astoycos astoycos commented Mar 7, 2022

This commit updates the documents involving the
submariner + OVN-K integration, and also re-does
the architecture diagram.

Signed-off-by: Andrew Stoycos astoycos@redhat.com

@submariner-bot
Copy link

🤖 Created branch: z_pr699/astoycos/update-ovn-k-resources

@astoycos
Copy link
Contributor Author

astoycos commented Mar 7, 2022

/ovn

@astoycos
Copy link
Contributor Author

astoycos commented Mar 7, 2022

/hold

until OVN related submariner PR's have merged

@netlify
Copy link

netlify bot commented Mar 7, 2022

Deploy Preview for elated-bell-2913d9 ready!

Name Link
🔨 Latest commit 949d8f1
🔍 Latest deploy log https://app.netlify.com/sites/elated-bell-2913d9/deploys/62b2104c0e73180008228a58
😎 Deploy Preview https://deploy-preview-699--elated-bell-2913d9.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@astoycos astoycos force-pushed the update-ovn-k-resources branch from 47bd5cf to 03d57ae Compare March 7, 2022 20:35
@github-actions github-actions bot removed the dependent label Mar 7, 2022
@astoycos astoycos changed the title Update Submariner OVN Documentation [WIP] Update Submariner OVN Documentation Mar 7, 2022
@nyechiel
Copy link
Member

nyechiel commented Mar 7, 2022

@astoycos as you probably noticed, we don't use Prow in this org so you have to manually add labels, etc. To mark a PR as draft, we typically use https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request as documented here.

@astoycos astoycos marked this pull request as draft March 8, 2022 02:51
@astoycos
Copy link
Contributor Author

astoycos commented Mar 8, 2022

Yep no worries!

@stale
Copy link

stale bot commented Mar 27, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Mar 27, 2022
@nyechiel nyechiel added confirmed For issues and PRs which we definitely want (disables the stale bot) and removed wontfix This will not be worked on labels Mar 27, 2022
Copy link
Member

@dfarrell07 dfarrell07 left a comment

Choose a reason for hiding this comment

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

This looks outstanding, major fixes/improvements. Thank you @astoycos!

Are we ready to undraft/review/merge?


![Submariner with OVNKubernetes architecture](/images/ovn-kubernetes/submariner-on-ovn-v2.svg)
![Submariner with OVNKubernetes architecture](/images/ovn-kubernetes/ovn-submariner-architecture.svg)
Copy link
Member

Choose a reason for hiding this comment

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

Nice diagram with explanation @astoycos, thanks.

Copy link
Member

Choose a reason for hiding this comment

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

@astoycos In the attached diagram, On OVN Submariner router, it is mentioned that "OVN Nat rules are applied here to ensure traffic is SNAT'ed to the globalnetIP when Globalnet is enabled".

Since this will be done when we support OVN with Globalnet and is not there currently, I'm not sure if we should capture this in the diagram. Basically, it might give an impression that Globalnet is supported even with OVN by looking into the diagram. What you do say?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@astoycos
Copy link
Contributor Author

@dfarrell07 This should be pretty much ready to go, I just wonder if we should wait until submariner-io/submariner#1689? Although there isn't any major architectural changes, I may need to edit/augment these docs based on reviews

@nyechiel nyechiel added the documentation Improvements or additions to documentation label Jun 14, 2022
@nyechiel
Copy link
Member

@vthapar this one should be ready to get merged now, can you please take it?

@vthapar vthapar marked this pull request as ready for review June 21, 2022 06:30
@vthapar vthapar changed the title [WIP] Update Submariner OVN Documentation Update Submariner OVN Documentation Jun 21, 2022
The following diagram illustrates the OVN Kubernetes handler architecture where the
blue elements represent the OVN Kubernetes native network elements and the yellow
elements are introduced by Submariner.
The following diagram illustrates the required Submariner OVN architecture overlayed
Copy link
Member

Choose a reason for hiding this comment

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

Can you please copy the original image to the following PPT [*] and add the following comment which will help us to make further changes in future if required.

<!-- Image Source: https://docs.google.com/presentation/d/180CtHZnr9PP5Rh98VEmkQz3ovc5AGXG9wosoHMLhgaY/edit -->

[*] https://docs.google.com/presentation/d/180CtHZnr9PP5Rh98VEmkQz3ovc5AGXG9wosoHMLhgaY/edit#slide=id.g8e581e9edd_0_142

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@nyechiel nyechiel linked an issue Jun 21, 2022 that may be closed by this pull request
@astoycos astoycos force-pushed the update-ovn-k-resources branch 2 times, most recently from 2271d60 to f572960 Compare June 21, 2022 18:32
This commit updates the documents involving the
submariner + OVN-K integration, and also re-does
the architecture diagram.

Signed-off-by: Andrew Stoycos <astoycos@redhat.com>
Copy link
Member

@nyechiel nyechiel left a comment

Choose a reason for hiding this comment

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

Thanks @astoycos

@astoycos astoycos force-pushed the update-ovn-k-resources branch from f572960 to 949d8f1 Compare June 21, 2022 18:39
@astoycos astoycos merged commit 742bd36 into submariner-io:devel Jun 21, 2022
@submariner-bot
Copy link

🤖 Closed branches: [z_pr699/astoycos/update-ovn-k-resources]

@sridhargaddam
Copy link
Member

Thanks @astoycos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed For issues and PRs which we definitely want (disables the stale bot) documentation Improvements or additions to documentation OVN
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update OVN support documentation
5 participants