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

1.8 Documentation updates #11892

Merged
merged 4 commits into from Jun 5, 2020
Merged

1.8 Documentation updates #11892

merged 4 commits into from Jun 5, 2020

Conversation

tgraf
Copy link
Member

@tgraf tgraf commented Jun 4, 2020

Fixes: #11868
Fixes: #11369

@tgraf tgraf added priority/release-blocker 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. labels Jun 4, 2020
@tgraf tgraf requested a review from a team as a code owner June 4, 2020 13:05
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.8.0 Jun 4, 2020
@tgraf tgraf marked this pull request as draft June 4, 2020 13:05
@maintainer-s-little-helper maintainer-s-little-helper bot added this to In progress in 1.8.0 Jun 4, 2020
@coveralls
Copy link

coveralls commented Jun 4, 2020

Coverage Status

Coverage decreased (-0.03%) to 36.927% when pulling 2ed353f on pr/tgraf/masq-doc into 6bd5b9c on master.

@tgraf tgraf requested a review from joestringer June 4, 2020 14:27
@tgraf tgraf marked this pull request as ready for review June 4, 2020 14:30
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.

LGTM, one minor comment below.

Would be nice to get a second view from someone like @seanmwinn / @jedsalazar .

Documentation/concepts/networking.rst Outdated Show resolved Hide resolved
Copy link
Member

@christarazi christarazi left a comment

Choose a reason for hiding this comment

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

LGTM, when I looked at #11868 yesterday, I noticed that we have two of the same Helm deploy instructions for AWS / EKS / ENI. See EKS guide and ENI guide. It'd be nice if we can consolidate these two Helm instruction sections into one, by putting the shared info into a separate file and referencing it in the two sections. This would help avoid an inconsistency cropping up like the above issue.

--------------------

eBPF-based
The eBPF-based implementation is the most efficient
Copy link
Member

Choose a reason for hiding this comment

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

Once this PR is emerged, I will extend this section to add more info about device selection.

tgraf added 3 commits June 5, 2020 13:43
Signed-off-by: Thomas Graf <thomas@cilium.io>
There is nothing nulti-node specific about this section. Rename it to
just networking.

Signed-off-by: Thomas Graf <thomas@cilium.io>
Fixes: c1a0025 ("doc: Fix require-ipv4-pod-cidr value for ENI and Azure mode")
Fixes: #11868

Signed-off-by: Thomas Graf <thomas@cilium.io>
Fixes: #11369

Signed-off-by: Thomas Graf <thomas@cilium.io>
@tgraf tgraf merged commit c1b3e32 into master Jun 5, 2020
1.8.0 automation moved this from In progress to Merged Jun 5, 2020
@tgraf tgraf deleted the pr/tgraf/masq-doc branch June 5, 2020 16:05
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.8 in 1.8.0 Jun 5, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.8 in 1.8.0 Jun 5, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.8 to Backport done to v1.8 in 1.8.0 Jun 6, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.8 to Backport done to v1.8 in 1.8.0 Jun 6, 2020
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. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.8.0
Backport done to v1.8
1.8.0
  
Merged
7 participants