Add detailed info about vlan capabilities on bridge #134

mlguerrero12 · 2023-10-06T16:14:26Z

It was not clear how the vlan related parameters worked. This aims to fill this gap.

dcbw · 2023-10-16T15:23:30Z

content/plugins/current/main/bridge.md

+
+The `vlan` and `vlanTrunk` parameters are mutually exclusive.
+
+The VLAN parameter configures the VLAN tag on the host end of the veth and also enables the vlan_filtering feature on the bridge interface. The VLAN_DEFAULT_PVID of the bridge (when set), is added by default on the port as a VID untagged on egress. This is in most cases not desirable. Use the `preserveDefaultVlan` parameter to remove it.


"The VLAN" -> "The vlan" (but with backticks around 'vlan'?)

Otherwise LGTM

done, thanks

s1061123 · 2023-10-16T15:27:42Z

content/plugins/current/main/bridge.md

+### Example L2-only vlan configuration
+```json
+{
+ "cniVersion": "0.3.1",
+ "name": "mynet",
+ "type": "bridge",
+ "bridge": "mynet0",
+ "vlan": 100,
+ "preserveDefaultVlan": false,
+ "ipam": {}
+}
+```
+
+### Example L2-only vlan trunk configuration
+```json
+{
+ "cniVersion": "0.3.1",
+ "name": "mynet",
+ "type": "bridge",
+ "bridge": "mynet0",
+ "vlanTrunk": [
+ { "id": 101 },
+ { "minID": 200, "maxID": 299 }],
+ "ipam": {}
+}
+```


note: It is just 'good to have' comment, so you can ignore that

How about to use latest CNI spec, "cniVersion": "1.0.0"? If you change "1.0.0", then you need to use "plugins"...

That would be good, indeed. However, most (if not all) of the configuration examples use version "0.3.1". So, let's create a separate PR where we update the version in the examples of all plugins.

EdDev

Thank you for making things clearer on how to support VLAN/s.

It is indeed challenging to explain this well, especially when the linux bridge has such a complex configuration.
I think my main point in my comments is that the explanation should be done from the abstraction provided by the plugin settings, not from the bridge perspective.

In classic switches, the notion of a trunk and a native VLAN is pretty clear. If it is possible to explain it in that manner here as well, it will help a lot.

EdDev · 2023-10-24T06:34:39Z

content/plugins/current/main/bridge.md

+
+The `vlan` and `vlanTrunk` parameters are mutually exclusive.
+
+The `vlan` parameter configures the VLAN tag on the host end of the veth and also enables the vlan_filtering feature on the bridge interface. The VLAN_DEFAULT_PVID of the bridge (when set), is added by default on the port as a VID untagged on egress. This is in most cases not desirable. Use the `preserveDefaultVlan` parameter to remove it.


It would be nice to try and explain this with VLAN_DEFAULT_PVID as a side-note, just because it is not assured that a reader will understand what it means.
E.g. it is not clear who sets it in the first place.
But, as commented in the next comment, I would suggest to avoid adding bridge details here, just explain the configuration abstracted in this plugin and its outcomes.

Also, could you please clarify what "default" preserveDefaultVlan refers to?
And what is its default value (when it does not appear in the config)?

Maybe it is worth trying to explain what are the side effects of having this set or not.

EdDev · 2023-10-24T06:37:45Z

content/plugins/current/main/bridge.md

+
+The `vlan` parameter configures the VLAN tag on the host end of the veth and also enables the vlan_filtering feature on the bridge interface. The VLAN_DEFAULT_PVID of the bridge (when set), is added by default on the port as a VID untagged on egress. This is in most cases not desirable. Use the `preserveDefaultVlan` parameter to remove it.
+
+The `vlanTrunk` parameter allows to add a single VID or a range of VIDs (see example below). The native vlan of the trunk is the VLAN_DEFAULT_PVID of the bridge. This VID is added by default on the port with PVID and UNTAGGED options enabled. There are two known limitations due to this. First, all trunk ports on the bridge have the same native vlan. Second, the default PVID of the bridge is currently not configurable.


This seems to try and explain things from the bridge perspective. It would help if the explanation is limited to the CNI plugin configuration which abstract the bridge side details.
Is this possible?

EdDev · 2023-10-24T06:44:19Z

content/plugins/current/main/bridge.md

+
+The `vlanTrunk` parameter allows to add a single VID or a range of VIDs (see example below). The native vlan of the trunk is the VLAN_DEFAULT_PVID of the bridge. This VID is added by default on the port with PVID and UNTAGGED options enabled. There are two known limitations due to this. First, all trunk ports on the bridge have the same native vlan. Second, the default PVID of the bridge is currently not configurable.
+
+To configure uplink for L2 network you need to allow the vlan on the uplink interface by using the following command ``` bridge vlan add vid VLAN_ID dev DEV```.


I am not sure what this is suppose to do exactly.
This tries to explain that the plugin will not do this and users should do it themselves?

I am guessing this relates to defining a trunk port from the bridge to the node interface.
Perhaps a small diagram will help explain this better.

that was there before. We could review this in another pr

mlguerrero12 · 2024-01-10T13:26:49Z

Thank you for making things clearer on how to support VLAN/s.

It is indeed challenging to explain this well, especially when the linux bridge has such a complex configuration. I think my main point in my comments is that the explanation should be done from the abstraction provided by the plugin settings, not from the bridge perspective.

In classic switches, the notion of a trunk and a native VLAN is pretty clear. If it is possible to explain it in that manner here as well, it will help a lot.

Thanks for the comments @EdDev.

I understand your point and agree with them. However, I decided to put bridge details because I've seen issues created asking for those. Also, there have been attempts to modify the way we do trunking here and we had to explain why it can't be. Here for example containernetworking/plugins#939.

For the above, I prefer to leave these details until we see how we can simplify the vlan support for the bridge.

It was not clear how the vlan related parameters worked. This aims to fill this gap. Signed-off-by: Marcelo Guerrero <marguerr@redhat.com>

mlguerrero12 mentioned this pull request Oct 6, 2023

Top-down documentation for bridge VLAN options containernetworking/plugins#939

Open

mlguerrero12 force-pushed the infoaboutvlan branch from ed3f279 to d4dc6bd Compare October 6, 2023 16:16

dcbw reviewed Oct 16, 2023

View reviewed changes

s1061123 reviewed Oct 16, 2023

View reviewed changes

squeed approved these changes Oct 16, 2023

View reviewed changes

mlguerrero12 force-pushed the infoaboutvlan branch from d4dc6bd to c0c7879 Compare October 16, 2023 15:42

mlguerrero12 mentioned this pull request Oct 23, 2023

documentation seems a bit unclear containernetworking/plugins#958

Closed

EdDev reviewed Oct 24, 2023

View reviewed changes

Add detailed info about vlan capabilities on bridge

4003b86

It was not clear how the vlan related parameters worked. This aims to fill this gap. Signed-off-by: Marcelo Guerrero <marguerr@redhat.com>

mlguerrero12 force-pushed the infoaboutvlan branch from c0c7879 to 4003b86 Compare July 11, 2024 14:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add detailed info about vlan capabilities on bridge #134

Add detailed info about vlan capabilities on bridge #134

mlguerrero12 commented Oct 6, 2023

dcbw Oct 16, 2023 •

edited

Loading

dcbw Oct 16, 2023

mlguerrero12 Oct 16, 2023

s1061123 Oct 16, 2023

mlguerrero12 Oct 16, 2023

EdDev left a comment

EdDev Oct 24, 2023

EdDev Oct 24, 2023

EdDev Oct 24, 2023

mlguerrero12 Jan 10, 2024

mlguerrero12 commented Jan 10, 2024


		The `vlan` and `vlanTrunk` parameters are mutually exclusive.

		The VLAN parameter configures the VLAN tag on the host end of the veth and also enables the vlan_filtering feature on the bridge interface. The VLAN_DEFAULT_PVID of the bridge (when set), is added by default on the port as a VID untagged on egress. This is in most cases not desirable. Use the `preserveDefaultVlan` parameter to remove it.


		The `vlan` and `vlanTrunk` parameters are mutually exclusive.

		The `vlan` parameter configures the VLAN tag on the host end of the veth and also enables the vlan_filtering feature on the bridge interface. The VLAN_DEFAULT_PVID of the bridge (when set), is added by default on the port as a VID untagged on egress. This is in most cases not desirable. Use the `preserveDefaultVlan` parameter to remove it.


		The `vlan` parameter configures the VLAN tag on the host end of the veth and also enables the vlan_filtering feature on the bridge interface. The VLAN_DEFAULT_PVID of the bridge (when set), is added by default on the port as a VID untagged on egress. This is in most cases not desirable. Use the `preserveDefaultVlan` parameter to remove it.

		The `vlanTrunk` parameter allows to add a single VID or a range of VIDs (see example below). The native vlan of the trunk is the VLAN_DEFAULT_PVID of the bridge. This VID is added by default on the port with PVID and UNTAGGED options enabled. There are two known limitations due to this. First, all trunk ports on the bridge have the same native vlan. Second, the default PVID of the bridge is currently not configurable.


		The `vlanTrunk` parameter allows to add a single VID or a range of VIDs (see example below). The native vlan of the trunk is the VLAN_DEFAULT_PVID of the bridge. This VID is added by default on the port with PVID and UNTAGGED options enabled. There are two known limitations due to this. First, all trunk ports on the bridge have the same native vlan. Second, the default PVID of the bridge is currently not configurable.

		To configure uplink for L2 network you need to allow the vlan on the uplink interface by using the following command ``` bridge vlan add vid VLAN_ID dev DEV```.

Add detailed info about vlan capabilities on bridge #134

Are you sure you want to change the base?

Add detailed info about vlan capabilities on bridge #134

Conversation

mlguerrero12 commented Oct 6, 2023

dcbw Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EdDev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlguerrero12 commented Jan 10, 2024

dcbw Oct 16, 2023 •

edited

Loading