Message ID | 1555432656-25077-1-git-send-email-ankur.sharma@nutanix.com |
---|---|
Headers | show |
Series | OVN: Distributed Virtual Router for Vlan Backed Networks | expand |
On Tue, Apr 16, 2019 at 11:37:14PM +0000, Ankur Sharma wrote: > This series is about enhancing the logical router functionality in OVN to work > with vlan backed logical switches. This series has a lot of style and cosmetic issues reported by the robot. Please take a look at them. I also noticed that it tends to use 3-space indents in many places rather than the 4-space standard adopted in OVS. The patch titles should begin with "ovn: ". The commit messages for this series are written mostly as bullet points that in some cases just say in words the same thing that the patch does in code. This is not the usual style for OVS/OVN. While it is useful to say at a high level what a patch does, generally we expect commit messages to focus on rationale. I do really appreciate that the patches contain references to the overall goal of the series. The documentation should give more details. The documentation for network_type, for example, just says this: + <column name="network_type"> + <p> + Whether logical switch is VLAN backed or Overlay. + </p> + + <p> + Default is overlay. + </p> + </column> which formats in the manpage as: network_type: optional string, either overlay or vlan Whether logical switch is VLAN backed or Overlay. Default is overlay. So, the first paragraph just repeats what the manpage will say anyway in the autogenerated text, and thus it can be removed. The second paragraph is useful. But it leaves out all the important information on what are VLAN backed or overlay networks and how the user can decide which one is appropriate in a given situation. Maybe this is not the exact place where that should be explained--but, if not, then it should be explained somewhere else, such as the ovn-architecture document, and this should refer the reader to wherever that is. It looks like "ovn-nbctl ls-add" now will fail to work with older databases, since it sets the network_type unconditionally. I think it would be a good idea to have it set the network_type only if the user specifies one. (Maybe it should validate that it is "vlan" or "overlay"?) Thanks, Ben.
Hi Ben, I have submitted a V4 with following changes. a. More elaborate documentation and commit messages. b. Converged the patch set to 2 patches. Dividing them as for E-W and N-S traffic. c. Changes in nbctl to NOT to set network_type if not given in argument. d. Fixed the 3 space indentations. Please take a look. Appreciate your feedback. Regards, Ankur -----Original Message----- From: Ben Pfaff <blp@ovn.org> Sent: Wednesday, April 17, 2019 11:17 AM To: Ankur Sharma <ankur.sharma@nutanix.com> Cc: ovs-dev@openvswitch.org Subject: Re: [ovs-dev] [PATCH v3 0/4] OVN: Distributed Virtual Router for Vlan Backed Networks On Tue, Apr 16, 2019 at 11:37:14PM +0000, Ankur Sharma wrote: > This series is about enhancing the logical router functionality in OVN > to work with vlan backed logical switches. This series has a lot of style and cosmetic issues reported by the robot. Please take a look at them. I also noticed that it tends to use 3-space indents in many places rather than the 4-space standard adopted in OVS. The patch titles should begin with "ovn: ". The commit messages for this series are written mostly as bullet points that in some cases just say in words the same thing that the patch does in code. This is not the usual style for OVS/OVN. While it is useful to say at a high level what a patch does, generally we expect commit messages to focus on rationale. I do really appreciate that the patches contain references to the overall goal of the series. The documentation should give more details. The documentation for network_type, for example, just says this: + <column name="network_type"> + <p> + Whether logical switch is VLAN backed or Overlay. + </p> + + <p> + Default is overlay. + </p> + </column> which formats in the manpage as: network_type: optional string, either overlay or vlan Whether logical switch is VLAN backed or Overlay. Default is overlay. So, the first paragraph just repeats what the manpage will say anyway in the autogenerated text, and thus it can be removed. The second paragraph is useful. But it leaves out all the important information on what are VLAN backed or overlay networks and how the user can decide which one is appropriate in a given situation. Maybe this is not the exact place where that should be explained--but, if not, then it should be explained somewhere else, such as the ovn-architecture document, and this should refer the reader to wherever that is. It looks like "ovn-nbctl ls-add" now will fail to work with older databases, since it sets the network_type unconditionally. I think it would be a good idea to have it set the network_type only if the user specifies one. (Maybe it should validate that it is "vlan" or "overlay"?) Thanks, Ben.