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

doc: make CSI host netowrking required #14023

Merged

Conversation

BlaineEXE
Copy link
Member

The network providers doc, including the holder pod migration sections, were developed with the understanding that CSI could be placed into pod networking mode if desired by users. In reality, this hasn't been supported due to bugs.

This allows streamlining the holder pod migration sections to no longer need to document for users what to do if they use CSI in pod network mode.

Rook will continue to have the CSI_ENABLE_HOST_NETWORK config available as an undocumented value. This can allow users who desperately cannot use host networking to still use pod networking, though this will mean any CSI node plugin updates could stall mounts for running apps. Thus we do not support it.

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

The network providers doc, including the holder pod migration sections,
were developed with the understanding that CSI could be placed into pod
networking mode if desired by users. In reality, this hasn't been
supported due to bugs.

This allows streamlining the holder pod migration sections to no longer
need to document for users what to do if they use CSI in pod network
mode.

Rook will continue to have the `CSI_ENABLE_HOST_NETWORK` config
available as an undocumented value. This can allow users who desperately
cannot use host networking to still use pod networking, though this will
mean any CSI node plugin updates could stall mounts for running apps.
Thus we do not support it.

Signed-off-by: Blaine Gardner <[email protected]>
@@ -79,27 +79,6 @@ to or from host networking after you update this setting, you will need to
[failover the mons](../../Storage-Configuration/Advanced/ceph-mon-health.md#failing-over-a-monitor)
in order to have mons on the desired network configuration.

## CSI Host Networking
Copy link
Member Author

Choose a reason for hiding this comment

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

In an earlier version of my work, I kept this section but renamed it CSI Pod Networking (unsupported) and changed some of the first paragraph to reflect that it is an option but isn't supported. In editing, I decided to remove the section entirely. If we encounter many multus users who have issues with the prerequisites, we may want to discuss adding this section back and having some limited support (mostly, setting the plugin upgrade strategy to OnDelete) for the pod networking with multus as an alternative.

Copy link
Member

@travisn travisn 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 a nice clarification and simplification!

@BlaineEXE BlaineEXE merged commit e11f81e into rook:master Apr 4, 2024
19 checks passed
@BlaineEXE BlaineEXE deleted the doc-network-csi-host-net-not-supported branch April 4, 2024 19:57
travisn added a commit that referenced this pull request Apr 4, 2024
doc: make CSI host netowrking required (backport #14023)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants