ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2024-12-19 21:57:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update firewall documentation

Browse Source 
Removes experimental warning and updates issues

Change-type: patch
This commit is contained in:
Felipe Lalanne 2024-11-07 11:04:32 -03:00
parent 89ab01a082
commit 1b747f6d65
No known key found for this signature in database
GPG Key ID: 03E696BFD472B26A
1 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/firewall.md
View File

@ -1,23 +1,19 @@
# Firewall
> Disclaimer: Firewall control in the Supervisor is still an experimental feature, so expect changes to come.
Starting with `Supervisor v11.9.1`, the balena Supervisor comes with the ability to control the device's firewall through the [`iptables` package](https://linux.die.net/man/8/iptables). The Supervisor manipulates the `filter` table to control network traffic.
## Firewall Modes
To switch between firewall modes, the `HOST_FIREWALL_MODE` (with `BALENA_` or legacy `RESIN_` prefix) configuration variable may be defined on a fleet or device level through the dashboard, and has three valid settings: `on`, `off`, and `auto`, with `off` being the default mode.
**Note:** Configuration variables defined in the dashboard will not apply to devices in local mode.
> [!NOTE] Configuration variables defined in the dashboard will not apply to devices in local mode.
| Mode | Description |
|------|-------------|
| on | Only traffic for core services provided by balena and containers on the host network are allowed. |
| off | All network traffic is allowed. |
| Mode | Description |
| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| on | Only traffic for core services provided by balena and containers on the host network are allowed. |
| off | All network traffic is allowed. |
| auto | If there _are_ host network services, behaves as if `FIREWALL_MODE` = `on`. If there _aren't_ host network services, behaves as if `FIREWALL_MODE` = `off`. |
## Issues
The Supervisor's implementation of `BALENA_HOST_FIREWALL_MODE` is not yet ideal. As such, please feel free to raise an issue. There is one notable issue where manually-set firewall rules to the `filter` table will be overwritten by the Supervisor (read more [here](https://github.com/balena-os/balena-supervisor/issues/1482)). The current workaround is to set these rules in the `raw` table.
Before [v14.9.2](https://github.com/balena-os/balena-supervisor/blob/master/CHANGELOG.md#v1492) manually-set firewall rules to the `filter` table will be overwritten by the Supervisor ([related issue](https://github.com/balena-os/balena-supervisor/issues/1482)). Please update your supervisor if you observe this behavior.