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: Improve BGP Control Plane page #23939

Merged
merged 3 commits into from
May 24, 2023
Merged

docs: Improve BGP Control Plane page #23939

merged 3 commits into from
May 24, 2023

Conversation

krouma
Copy link
Contributor

@krouma krouma commented Feb 22, 2023

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Thanks for contributing!

Fixes: #23817

Clarifies installation of BGP Control Plane
Fixes non-functional hyperlinks

@krouma krouma requested review from a team as code owners February 22, 2023 13:20
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Feb 22, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Feb 22, 2023
Documentation/network/bgp-control-plane.rst Outdated Show resolved Hide resolved
Documentation/network/bgp-control-plane.rst Outdated Show resolved Hide resolved
@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. area/bgp labels Feb 24, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Feb 24, 2023
@aanm aanm requested a review from qmonnet March 6, 2023 13:12
Copy link
Member

@qmonnet qmonnet left a 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>
Copy link
Member

@qmonnet qmonnet left a 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.

@krouma
Copy link
Contributor Author

krouma commented Mar 6, 2023

Yes, I just clicked to rerequest review and didn't notice it removed the second one.

@qmonnet
Copy link
Member

qmonnet commented Mar 6, 2023

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?

@pchaigno pchaigno mentioned this pull request Mar 7, 2023
2 tasks
@dylandreimerink
Copy link
Member

dylandreimerink commented Mar 9, 2023

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.

@github-actions
Copy link

github-actions bot commented Apr 9, 2023

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.

@github-actions github-actions bot added the stale The stale bot thinks this issue is old. Add "pinned" label to prevent this from becoming stale. label Apr 9, 2023
@github-actions github-actions bot removed the stale The stale bot thinks this issue is old. Add "pinned" label to prevent this from becoming stale. label Apr 19, 2023
@joestringer
Copy link
Member

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.

@joestringer
Copy link
Member

joestringer commented May 5, 2023

@krouma is the feedback clear at this point? From a PR triager perspective, I see the following:

  • sig-bgp still needs to approve the PR
  • The full testsuite needs to be run
  • Given that the last push was about 2 months ago, it's likely that the PR will need a rebase before we can successfully run the full CI with /test.

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?

@joestringer joestringer added the needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch label May 24, 2023
@joestringer joestringer merged commit 00ae20d into cilium:main May 24, 2023
@krouma krouma deleted the bpfcp branch May 26, 2023 21:28
@sayboras sayboras mentioned this pull request May 28, 2023
10 tasks
@sayboras sayboras added backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. and removed backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch labels May 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/bgp area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. kind/community-contribution This was a contribution made by a community member. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BGP Control Plane is not used
5 participants