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: ENIs should not be managed by the OS #16186

Merged
merged 1 commit into from Jun 8, 2021

Conversation

gandro
Copy link
Member

@gandro gandro commented May 17, 2021

When ENIs are managed by services such as NetworkManager or
systemd-networkd, it can happen that they interfere with Cilium's
configuration. For example, systemd-networkd can remove the ENI IP
assigned by Cilium if the carrier is temporarily down, thus breaking
SNAT.

We previously had a similar section regarding NetworkManager and DHCP in
the EKS installation guide, but the EKS guide has since been replaced by
the Cilium CLI installation guide.

This section here therefore acts as a replacement and states that the
devices need to be unmanaged (e.g. disabling DHCP is not enough for
systemd-networkd).

When ENIs are managed by services such as NetworkManager or
systemd-networkd, it can happen that they interfere with Cilium's
configuration. For example, systemd-networkd can remove the ENI IP
assigned by Cilium if the carrier is temporarily down, thus breaking
SNAT.

We previously had a similar section regarding NetworkManager and DHCP in
the EKS installation guide, but the EKS guide has since been replaced by
the Cilium CLI installation guide.

This section here therefore acts as a replacement and states that the
devices need to be unmanaged (e.g. disabling DHCP is not enough for
systemd-networkd).

Signed-off-by: Sebastian Wicki <sebastian@isovalent.com>
@gandro gandro added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/eni Impacts ENI based IPAM. release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.8 labels May 17, 2021
@gandro gandro requested review from a team as code owners May 17, 2021 17:08
@gandro gandro requested review from a team, tgraf and joestringer May 17, 2021 17:08
@gandro gandro changed the title docs: ENIs should not be unmanaged by the OS docs: ENIs should not be managed by the OS May 17, 2021

.. tabs::

.. group-tab:: Network Manager
Copy link
Member

Choose a reason for hiding this comment

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

For future reference these tabs don't need to be grouped, I think basic tabs would work too. But not an issue and it's not as if we paid a lot of attention to it in the rest of the documentation anyway.

Copy link
Member Author

Choose a reason for hiding this comment

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

I actually didn't know that basic tabs existed, thanks for pointing this out! If we ever add an additional tabs section to expand on the required network config on this page, they most likely would be grouped together with the above. So I'll leave them as they are for now.

@gandro gandro removed the request for review from joestringer June 8, 2021 08:28
@gandro gandro added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jun 8, 2021
@aanm aanm merged commit b15cee1 into cilium:master Jun 8, 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. area/eni Impacts ENI based IPAM. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. 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.

None yet

8 participants