Skip to content

Getting started guide for the host firewall#12537

Merged
qmonnet merged 5 commits intomasterfrom
pr/pchaigno/gsg-host-firewall
Jul 20, 2020
Merged

Getting started guide for the host firewall#12537
qmonnet merged 5 commits intomasterfrom
pr/pchaigno/gsg-host-firewall

Conversation

@pchaigno
Copy link
Copy Markdown
Member

First version of the host firewall getting started guide (GSG). I still want to extend it with a more extensive troubleshooting section than we have in Network Policy > Host Policies (or I'll add a section in Troubleshooting for the host firewall). I may also extend the GSG later to include some example of policies on path hostns <-> pods.

Fixes: #12278
Updates: #11799

Add a getting started guide for the host firewall

@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/minor This PR changes functionality that users may find relevant to operating Cilium. needs-backport/1.8 labels Jul 15, 2020
@pchaigno pchaigno marked this pull request as ready for review July 15, 2020 17:34
@pchaigno pchaigno requested a review from a team as a code owner July 15, 2020 17:34
@pchaigno pchaigno force-pushed the pr/pchaigno/gsg-host-firewall branch from 5839b28 to 502cc53 Compare July 15, 2020 18:08
@coveralls
Copy link
Copy Markdown

coveralls commented Jul 15, 2020

Coverage Status

Coverage increased (+0.02%) to 37.002% when pulling 2af7ceb on pr/pchaigno/gsg-host-firewall into ba9031b on master.

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.

Awesome guide, thanks.

I didn't try it out, but I noticed some issues that may cause problems for users. I also gave some wordsmithing suggestions below.

Comment thread Documentation/gettingstarted/host-firewall.rst Outdated
Comment thread Documentation/gettingstarted/host-firewall.rst Outdated
Comment thread Documentation/gettingstarted/host-firewall.rst Outdated
Comment thread Documentation/gettingstarted/host-firewall.rst
@pchaigno pchaigno force-pushed the pr/pchaigno/gsg-host-firewall branch from 502cc53 to 127f1bc Compare July 16, 2020 14:00
@pchaigno pchaigno requested a review from joestringer July 16, 2020 14:01
pchaigno added 5 commits July 17, 2020 19:29
First version of the host firewall GSG. I still want to extend it with a
more extensive troubleshooting section than we have in Network Policy >
Host Policies (or I'll add a section in Troubleshooting for the host
firewall). I may also extend the GSG later to include some example of
policies on path hostns <-> pods.

Fixes: #12278
Signed-off-by: Paul Chaignon <paul@cilium.io>
We need to remove it from the title or otherwise it is included wherever
we reference host policies with:

    :ref:`HostPolicies`

There is already a note on the beta status below the title anyway.

Signed-off-by: Paul Chaignon <paul@cilium.io>
Host examples are now hosted in examples/policies/host.

Signed-off-by: Paul Chaignon <paul@cilium.io>
To be on the safe side and avoid breaking the cluster, we can allow
remote nodes and the health endpoint. Without this, we will at least
drop some ICMP probes.

Signed-off-by: Paul Chaignon <paul@cilium.io>
Relying on node labels to apply the host policy in the host firewall
getting started guide allows us to include fully working commands
throughout the guide.

Without this, commands cannot include the 'kubectl exec' part because we
don't know on what node and cilium pod the user is executing them.

Signed-off-by: Paul Chaignon <paul@cilium.io>
@pchaigno pchaigno force-pushed the pr/pchaigno/gsg-host-firewall branch from 127f1bc to 2af7ceb Compare July 17, 2020 17:30
@pchaigno pchaigno requested a review from qmonnet July 17, 2020 17:30
@pchaigno
Copy link
Copy Markdown
Member Author

I've addressed the last review comments in the last branch update.

It includes one new commit to address #12537 (comment) and allow us to explicitly state each command that needs to be executed in full (including kubectl exec part). I've separated this commit because it requires #12573 to be merged first. I'd really like to get the base GSG in 1.8.2, so if we estimate #12573 won't be merged in time for 1.8.2, I can remove the last commit from the present PR and send as a followup.

@pchaigno pchaigno added the dont-merge/blocked Another PR must be merged before this one. label Jul 17, 2020
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.

Looks good, didn't try it out yet.

@pchaigno pchaigno removed the dont-merge/blocked Another PR must be merged before this one. label Jul 20, 2020
@pchaigno
Copy link
Copy Markdown
Member Author

Reviews are in and documentation tests passed.

@pchaigno pchaigno added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 20, 2020
@qmonnet qmonnet merged commit 2aae988 into master Jul 20, 2020
@qmonnet qmonnet deleted the pr/pchaigno/gsg-host-firewall branch July 20, 2020 09:00
@pchaigno pchaigno added the area/host-firewall Impacts the host firewall or the host endpoint. label Jul 20, 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. area/host-firewall Impacts the host firewall or the host endpoint. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/minor This PR changes functionality that users may find relevant to operating Cilium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve host policies documentation

4 participants