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

Add network interface binding documentation #1008

Merged
merged 7 commits into from
Dec 22, 2024

Conversation

mohsenrezaeithe
Copy link
Contributor

@mohsenrezaeithe mohsenrezaeithe commented Dec 18, 2024

Fixes #1006

This would help users of the Docker container approach to be able to bind their updater to a specific network interface and get the right public IP.

Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.94%. Comparing base (58dd607) to head (8d73a02).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1008   +/-   ##
=======================================
  Coverage   94.94%   94.94%           
=======================================
  Files          62       62           
  Lines        3366     3366           
=======================================
  Hits         3196     3196           
  Misses        158      158           
  Partials       12       12           
Flag Coverage Δ
unittests 94.94% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@favonia
Copy link
Owner

favonia commented Dec 18, 2024

Thank you. I have two broad suggestions:

  1. I prefer not to clutter the initial template, especially when the setting network_mode: might conflict with networks:.
  2. Perhaps we should warn that this might bypass quotas or firewalls for a specific network interface. For instance, the specially routed traffic might not count towards the quota set on the host.

Also, I think this is significant enough that you should list yourself in CONTRIBUTORS.markdown. 😉

@mohsenrezaeithe
Copy link
Contributor Author

  1. I prefer not to clutter the initial template, especially when the setting network_mode: might conflict with networks:.

Updated.

  1. Perhaps we should warn that this might bypass quotas or firewalls for a specific network interface. For instance, the specially routed traffic might not count towards the quota set on the host.

I don't follow. I'm not familiar with any OS level quotas that'd affect this.

@favonia
Copy link
Owner

favonia commented Dec 19, 2024

3. Perhaps we should warn that this might bypass quotas or firewalls for a specific network interface. For instance, the specially routed traffic might not count towards the quota set on the host.

I don't follow. I'm not familiar with any OS level quotas that'd affect this.

I wasn't being clear—I was talking about iptables and nftables. You can set up quotas or other rules on the host, and I believe macvlan will bypass them. In other words, the host (almost) can't see the traffic.

@mohsenrezaeithe
Copy link
Contributor Author

I wasn't being clear—I was talking about iptables and nftables. You can set up quotas or other rules on the host, and I believe macvlan will bypass them. In other words, the host (almost) can't see the traffic.

Makes sense. I've added a note in the docs.

@favonia
Copy link
Owner

favonia commented Dec 22, 2024

@mohsenrezaeithe Thank you for your contribution! ❤️

@favonia favonia merged commit 051d8e2 into favonia:main Dec 22, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ability to use a specific interface regardless of the Provider
2 participants