-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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: Improve BGP Control Plane page #23939
Conversation
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.
Thank you, the changes look all good.
Could you please fold the new commits (4 and 5) into the relevant commits (1 and 2 I think)? You can drop the Co-authored-by:
tags, in particular because GitHub generates them with my personal email instead of work email.
There was only CLI argument. This adds a fragment of Helm values file to enable BGP Control Plane Signed-off-by: Matyáš Kroupa <kroupa.matyas@gmail.com>
It was not clear that only one of BGP and BGP Control plane can be used at the same time. This adds a note to the documentation about the implementations. Fixes: cilium#23817 Signed-off-by: Matyáš Kroupa <kroupa.matyas@gmail.com>
The Virtual Router Attributes link in BGP Control Plane used incorrect hyperlink. Signed-off-by: Matyáš Kroupa <kroupa.matyas@gmail.com>
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.
Looks good to me, thank you!
Re-adding review request to Dylan, which was presumably removed by accident.
Yes, I just clicked to rerequest review and didn't notice it removed the second one. |
Dylan: Just thinking, while reviewing this PR again: If the two different BGP features are mutually exclusive, should we consider a follow-up PR to make the Cilium agent fail to start if both are required by the user? |
To be honest, I don't know if the two are mutually exclusive, I will double check this for myself. However, I can recall a few issues where I have seem users enable both at the same time and them being confused as to why configuration from the legacy feature doesn't apply to the BGP Control Plane. I think there fundamentally isn't a conflict since both use different methods of configuration and do not interfere on a network level as far as I know. And I would not enforce mutual exclusion in the agent since that would make migrating from MetalLB to BGP CP harder. I still agree with the spirit of this doc change, but I suggest we change it be advisory and keep the clarification that enabling BGP CP does not disable the legacy BGP feature. |
This pull request has been automatically marked as stale because it |
While two different BGP modes might not technically be exclusive, if we can't come up with a legitimate use case to combine the two, then it may simplify support and user expectations if we mark them as mutually exclusive anyway. If someone really has such a use case, they could raise the discussion point and we could consider relaxing the restriction at that time. |
@krouma is the feedback clear at this point? From a PR triager perspective, I see the following:
EDIT: After posting the comment, I realized this is a docs-only PR, so full CI does not need to run. This is just blocking on sig-bgp feedback. @dylandreimerink does this improve overall codebase health? Are you happy with the proposal or do you see specific things that need to be changed to ensure that the proposal improves the health of the tree/docs? |
Please ensure your pull request adheres to the following guidelines:
description and a
Fixes: #XXX
line if the commit addresses a particularGitHub issue.
Fixes: <commit-id>
tag, thenplease add the commit author[s] as reviewer[s] to this issue.
Fixes: #23817
Clarifies installation of BGP Control Plane
Fixes non-functional hyperlinks