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 the bandwidth manager page #16783

Merged
merged 2 commits into from Jul 23, 2021
Merged

docs: improve the bandwidth manager page #16783

merged 2 commits into from Jul 23, 2021

Conversation

bmcustodio
Copy link
Contributor

Attempts to make the "Bandwidth Manager" page more user-friendly by deploying a server pod and a client pod that is guaranteed to not be colocated with the former. Also provides friendlier commands for making the netperf test, as well as to check the status of the bandwidth manager.

Related to this PR is #16782, but the current one needs backporting to both v1.9 and v.10, whereas #16782 is only required to be backported to v1.10.

docs: improve the bandwidth manager page

@bmcustodio bmcustodio requested a review from a team July 5, 2021 13:53
@bmcustodio bmcustodio requested a review from a team as a code owner July 5, 2021 13:53
@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 Jul 5, 2021
@bmcustodio bmcustodio added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-pending/1.9 kind/enhancement This would improve or streamline existing functionality. labels Jul 5, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Backport pending to v1.10 in 1.10.3 Jul 5, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Backport pending to v1.9 in 1.9.9 Jul 5, 2021
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

Are the backports really already pending? Or should that be needs-backport/xxx? I don't see any other PRs referencing this PR, and if this PR isn't merged yet then the backporting scripts won't pick this up.

Copy link
Member

@borkmann borkmann left a comment

Choose a reason for hiding this comment

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

few small nits

Documentation/gettingstarted/bandwidth-manager.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/bandwidth-manager.rst Outdated Show resolved Hide resolved
Documentation/gettingstarted/bandwidth-manager.rst Outdated Show resolved Hide resolved
@aanm aanm added this to Backport pending to v1.10 in 1.10.4 Jul 15, 2021
@aanm aanm removed this from Backport pending to v1.10 in 1.10.3 Jul 15, 2021
@joestringer
Copy link
Member

@bmcustodio were you planning to get back to this?

@joestringer joestringer added this to Backport pending to v1.9 in 1.9.10 Jul 19, 2021
@joestringer joestringer removed this from Backport pending to v1.9 in 1.9.9 Jul 19, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.9.9 Jul 19, 2021
@joestringer
Copy link
Member

I've updated the labels to reflect that this PR will need backporting, since I couldn't tell if the backport process was already kicked off somewhere. If you have started backporting them, then feel free to set the labels back to backport-pending/....

@joestringer joestringer moved this from Backport pending to v1.9 to Needs backport from master in 1.9.10 Jul 19, 2021
@joestringer joestringer removed this from Needs backport from master in 1.9.9 Jul 19, 2021
Attempts to make the "Bandwidth Manager" page more user-friendly by
deploying a server pod and a client pod that is guaranteed to not be
colocated with the former. Also provides friendlier commands for
making the 'netperf' test, as well as to check the status of the
bandwidth manager.

Signed-off-by: Bruno Miguel Custódio <brunomcustodio@gmail.com>
Signed-off-by: Bruno Miguel Custódio <brunomcustodio@gmail.com>
@joestringer joestringer added the release-note/misc This PR makes changes that have no direct user impact. label Jul 21, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jul 21, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.10 to Needs backport from master in 1.10.4 Jul 21, 2021
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

Looks like @borkmann 's review comments have been addressed. Should be good to merge now.

@joestringer joestringer merged commit fa00a1b into cilium:master Jul 23, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.10 in 1.10.4 Jul 26, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.9 in 1.9.10 Jul 26, 2021
@jibi jibi mentioned this pull request Jul 26, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.10 to Backport done to v1.10 in 1.10.4 Jul 27, 2021
@joestringer joestringer added this to Backport pending to v1.9 in 1.9.11 Sep 1, 2021
@joestringer joestringer removed this from Backport pending to v1.9 in 1.9.10 Sep 1, 2021
@joestringer joestringer removed this from Backport pending to v1.9 in 1.9.11 Sep 1, 2021
@joestringer joestringer added this to Backport done to v1.9 in 1.9.10 Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/enhancement This would improve or streamline existing functionality. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.10.4
Backport done to v1.10
1.9.10
Backport done to v1.9
Development

Successfully merging this pull request may close these issues.

None yet

5 participants