From 5d23d8e6b09c623cb910159dee40df6af2844856 Mon Sep 17 00:00:00 2001
From: Bob Fournier <bfournie@redhat.com>
Date: Tue, 3 Nov 2020 09:58:41 -0500
Subject: [PATCH] Add support for vlan interfaces in dhcp-all-interfaces.sh

Provide ability to run dhcp client on VLAN interfaces created on
top of an Ethernet interface.  See also
<https://storyboard.openstack.org/#!/story/2008298>`__ for further details.

Change-Id: Ic3ffd7b8e23b1e996cfe6c79ce0ff47e521f30be
---
 .../install.d/dhcp-all-interfaces.sh          | 35 ++++++++++++++++---
 ...dhcp-vlan-interfaces-b34ab224b9431e3a.yaml |  8 +++++
 2 files changed, 39 insertions(+), 4 deletions(-)
 create mode 100644 releasenotes/notes/dhcp-vlan-interfaces-b34ab224b9431e3a.yaml

diff --git a/diskimage_builder/elements/dhcp-all-interfaces/install.d/dhcp-all-interfaces.sh b/diskimage_builder/elements/dhcp-all-interfaces/install.d/dhcp-all-interfaces.sh
index 1a2e69630..e63f3c20a 100755
--- a/diskimage_builder/elements/dhcp-all-interfaces/install.d/dhcp-all-interfaces.sh
+++ b/diskimage_builder/elements/dhcp-all-interfaces/install.d/dhcp-all-interfaces.sh
@@ -45,6 +45,29 @@ function get_if_type() {
     cat /sys/class/net/${1}/type
 }
 
+function interface_is_vlan() {
+    # Check if this is a vlan interface created on top of an Ethernet interface.
+    local interface=$1
+
+    # When the vlan interface is created, its mac address is copied from the
+    # underlying address and the address assignment type is set to 2
+    mac_addr_type=$(cat /sys/class/net/${interface}/addr_assign_type)
+    if [ "$mac_addr_type" != "2" ]; then
+        return 1
+    fi
+
+    # Only check for vlan interfaces named <interface>.<vlan>
+    lower_interface="$(echo $interface | cut -f1 -d'.')"
+    if [[ ! -z $lower_interface ]]; then
+        mac_addr_type=$(cat /sys/class/net/${lower_interface}/addr_assign_type)
+        if [ "$mac_addr_type" == "0" ]; then
+            return 0 # interface is vlan
+        fi
+    fi
+
+    return 1
+}
+
 function enable_interface() {
     local interface=$1
     local ipv6_init=$2
@@ -76,7 +99,11 @@ function enable_interface() {
         if [ "$(get_if_type $interface)" == "32" ]; then
             printf "DEVICE=\"$interface\"\nBOOTPROTO=\"dhcp\"\nONBOOT=\"yes\"\nTYPE=\"InfiniBand\"\nCONNECTED_MODE=\"no\"\nDEFROUTE=\"yes\"\nPEERDNS=\"yes\"\nPEERROUTES=\"yes\"\nIPV4_FAILURE_FATAL=\"yes\"\nIPV6INIT=\"no\"" >"${SCRIPTS_PATH}ifcfg-$interface"
         else
-            printf "DEVICE=\"$interface\"\nBOOTPROTO=\"dhcp\"\nONBOOT=\"yes\"\nTYPE=\"Ethernet\"\n" >"${SCRIPTS_PATH}ifcfg-$interface"
+            if interface_is_vlan $interface; then
+                printf "DEVICE=\"$interface\"\nBOOTPROTO=\"dhcp\"\nONBOOT=\"yes\"\nVLAN=\"yes\"\n" >"${SCRIPTS_PATH}ifcfg-$interface"
+            else
+                printf "DEVICE=\"$interface\"\nBOOTPROTO=\"dhcp\"\nONBOOT=\"yes\"\nTYPE=\"Ethernet\"\n" >"${SCRIPTS_PATH}ifcfg-$interface"
+            fi
             if [ "$ipv6_init" == "True" ]; then
                 # Make DUID-UUID Type 4 (RFC 6355)
                 echo "default-duid \"\\x00\\x04$(sed 's/.\{2\}/\\x&/g' < /etc/machine-id)\";" >"/var/lib/dhclient/dhclient6--$interface.lease"
@@ -132,9 +159,7 @@ function inspect_interface() {
     echo -n "Inspecting interface: $interface..."
     if config_exists $interface; then
         echo "Has config, skipping."
-    elif [ "$mac_addr_type" != "0" ]; then
-        echo "Device has generated MAC, skipping."
-    else
+    elif interface_is_vlan $interface || [ "$mac_addr_type" == "0" ]; then
         local has_link
         local tries=DIB_DHCP_TIMEOUT
         for ((; tries > 0; tries--)); do
@@ -180,6 +205,8 @@ function inspect_interface() {
         else
             echo "No link detected, skipping"
         fi
+    else
+        echo "Device has generated MAC, skipping."
     fi
 }
 
diff --git a/releasenotes/notes/dhcp-vlan-interfaces-b34ab224b9431e3a.yaml b/releasenotes/notes/dhcp-vlan-interfaces-b34ab224b9431e3a.yaml
new file mode 100644
index 000000000..410d6e427
--- /dev/null
+++ b/releasenotes/notes/dhcp-vlan-interfaces-b34ab224b9431e3a.yaml
@@ -0,0 +1,8 @@
+---
+features:
+  - |
+    Add support to run dhclient on vlan interfaces created on top of
+    an Ethernet interface.  The vlan interfaces in this case will use
+    the default naming convention of <interface>.<vlan>. See also
+    <https://storyboard.openstack.org/#!/story/2008298>`__
+    for further details.