Skip to content

1.8 documentation updates: Concepts & menu structure#11979

Merged
tgraf merged 17 commits intomasterfrom
pr/tgraf/1.8-docs
Jun 17, 2020
Merged

1.8 documentation updates: Concepts & menu structure#11979
tgraf merged 17 commits intomasterfrom
pr/tgraf/1.8-docs

Conversation

@tgraf
Copy link
Copy Markdown
Contributor

@tgraf tgraf commented Jun 9, 2020

No description provided.

@tgraf tgraf 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. needs-backport/1.8 labels Jun 9, 2020
@tgraf tgraf requested a review from a team as a code owner June 9, 2020 11:03
@tgraf tgraf marked this pull request as draft June 9, 2020 11:03
@coveralls
Copy link
Copy Markdown

coveralls commented Jun 9, 2020

Coverage Status

Coverage decreased (-0.02%) to 37.072% when pulling 3515246 on pr/tgraf/1.8-docs into bf64aa9 on master.

@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch 3 times, most recently from c809196 to 9f1823c Compare June 9, 2020 15:56
Copy link
Copy Markdown
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.

Some minor comments as a first pass.

Comment thread Documentation/concepts/ipam/cluster-pool.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Copy link
Copy Markdown
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.

First-pass comments, looks good overall

Comment thread Documentation/concepts/ipam/deep_dive.rst Outdated
Comment thread Documentation/concepts/ipam/index.rst Outdated
Comment thread Documentation/concepts/networking/masquerading.rst Outdated
Comment thread Documentation/concepts/networking/masquerading.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Comment thread Documentation/concepts/networking/routing.rst Outdated
Comment thread Documentation/concepts/overview.rst Outdated
Comment thread Documentation/concepts/overview.rst Outdated
Comment thread Documentation/concepts/overview.rst Outdated
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch 2 times, most recently from 04011b5 to 0bcd132 Compare June 10, 2020 14:14
@joestringer joestringer self-requested a review June 10, 2020 16:21
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch from 6655506 to 8311601 Compare June 10, 2020 17:06
@christarazi christarazi self-requested a review June 11, 2020 05:36
@tgraf tgraf marked this pull request as ready for review June 11, 2020 08:19
@tgraf tgraf requested a review from a team June 11, 2020 08:19
@tgraf tgraf requested a review from a team as a code owner June 11, 2020 08:19
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch 2 times, most recently from da20b5d to 34c7d5f Compare June 11, 2020 10:04
@tgraf tgraf changed the title [WIP] 1.8 documentation updates 1.8 documentation updates: Concepts & menu structure Jun 11, 2020
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch from 34c7d5f to b75dac2 Compare June 11, 2020 11:26
@aanm aanm added the dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. label Jun 11, 2020
@tgraf
Copy link
Copy Markdown
Contributor Author

tgraf commented Jun 11, 2020

I will wait with the rebase until final reviews come in

Comment thread Documentation/intro.rst Outdated
Comment thread Documentation/intro.rst Outdated
Comment thread Documentation/concepts/overview.rst Outdated
Copy link
Copy Markdown
Contributor

@michi-covalent michi-covalent left a comment

Choose a reason for hiding this comment

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

reviewed:

  • Documentation/intro.rst
  • Documentation/index.rst
  • Documentation/concepts/overview.rst

Comment thread Documentation/concepts/overview.rst Outdated
Comment thread Documentation/concepts/ipam/index.rst Outdated
Comment thread Documentation/gettingstarted/mesos.rst
Comment thread Documentation/gettingstarted/mesos.rst
Comment thread Documentation/concepts/overview.rst Outdated
Comment thread Documentation/intro.rst Outdated
Comment thread Documentation/concepts/ebpf/iptables.rst Outdated
Comment thread Documentation/concepts/ebpf/lifeofapacket.rst
Comment thread Documentation/concepts/ebpf/lifeofapacket.rst Outdated
Comment thread Documentation/concepts/security/intro.rst Outdated
Comment thread Documentation/concepts/security/intro.rst Outdated
@tgraf
Copy link
Copy Markdown
Contributor Author

tgraf commented Jun 17, 2020

FYI: The vast majority of comments are on existing documentation that was moved. I don't mind addressing all of it but it may make future reviews harder.

* Move the detailed flow deep dive into a sub section
* Mark Cluster Scope / Pool as the default IPAM
* Mark old host scope as legacy

Signed-off-by: Thomas Graf <thomas@cilium.io>
tgraf added 3 commits June 17, 2020 09:49
* Mention all involved components
* Use the compoonent overview for a high-level description. More
  detailed descriptions will be added in dedicated concepts chapters.

Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
The different routing modes have been spread across multiple different
chapters. Consolidate it all in a single place: Concepts -> Networking
-> Routing.

Also split out multi-cluster to extend it later.

Signed-off-by: Thomas Graf <thomas@cilium.io>
@tgraf tgraf removed the dont-merge/needs-rebase This PR needs to be rebased because it has merge conflicts. label Jun 17, 2020
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch from b75dac2 to 0ef5dca Compare June 17, 2020 13:02
tgraf added 11 commits June 17, 2020 15:07
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Also removes the oudated Kubernetes section.

Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
It only refers to the getting started guide

Signed-off-by: Thomas Graf <thomas@cilium.io>
The information is duplicated from the getting started guide.

Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Signed-off-by: Thomas Graf <thomas@cilium.io>
Also removes an outdated section about future roadmap

Signed-off-by: Thomas Graf <thomas@cilium.io>
@tgraf tgraf force-pushed the pr/tgraf/1.8-docs branch from 0ef5dca to 3515246 Compare June 17, 2020 13:15
@tgraf tgraf merged commit cdf6b3b into master Jun 17, 2020
@tgraf tgraf deleted the pr/tgraf/1.8-docs branch June 17, 2020 13:31
tklauser added a commit that referenced this pull request Jun 18, 2020
The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
joestringer pushed a commit that referenced this pull request Jun 18, 2020
The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
borkmann pushed a commit that referenced this pull request Jun 18, 2020
[ upstream commit 3ab3d68 ]

The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
borkmann pushed a commit that referenced this pull request Jun 18, 2020
[ upstream commit 3ab3d68 ]

The documentation about the BPF map scale and limitation is currently
duplicated. The version in the "Introduction" section (intro.rst) was
updated with the most recent changes, while the version in the "Maps"
section (which was split out in #11979 into maps.rst) contains an
outdated version.  Move all the up-to-date info to maps.rst.
Incidentally, this also makes the last sentence in the previous section
"Below we show the following possible flows..." make sense again since
it refers to the figure in section "Kubernetes Integration".

Signed-off-by: Tobias Klauser <tklauser@distanz.ch>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
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

None yet

Development

Successfully merging this pull request may close these issues.

9 participants