Merge ~fnordahl/ubuntu/+source/openvswitch:bug/1915829 into ~ubuntu-server-dev/ubuntu/+source/openvswitch:master

[Frode Nordahl]

[Christian Ehrhardt  (paelzer)]

Hirsute isn't released yet - so it would be 2.15.0-0ubuntu2

Other than this minor issue it does LGTM.
Of course to avoid diverging too much you might want to wait to see it accepted upstream before uploading (depends on how close that accept gets to the Freeze).

Also FYI - 2.15.0 still is held in -unapproved as we are soft freezing atm
https://launchpad.net/ubuntu/hirsute/+queue?queue_state=1
(Just in case you wondered)

review: Needs Fixing

[Frode Nordahl (fnordahl)]

Thank you for the review Christian.

Updated the package version and updated the patch to now match the version merged upstream [0].

We got it backported all the way to 2.13, but I would like to proceed with carrying it as a patch in the packaging until a upstream point release is cut as there are downstream issues waiting to be resolved by this fix.

Hope this resonates well with you.

0: https://mail.openvswitch.org/pipermail/ovs-dev/2021-March/380889.html

diff --git a/debian/changelog b/debian/changelog
index 3fecc16..6407d66 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,21 @@
+openvswitch (2.15.0-0ubuntu2) hirsute; urgency=medium
+
+  * Fix recording of FQDN / hostname on startup (LP: #1915829)
+    - d/p/ovs-dev-ovs-ctl-Allow-recording-hostname-separately.patch
+    - d/openvswitch-switch.ovs-record-hostname.service: Record hostname in
+      Open vSwitch after network-online.target
+    - d/openvswitch-switch.ovs-vswitchd.service: Pass `--no-record-hostname`
+      option to `ovs-ctl` to delegate recording of hostname to the separate
+      service.
+    - d/openvswitch-switch.ovsdb-server.service: Pass `--no-record-hostname`
+      option to `ovs-ctl` to delegate recording of hostname to the separate
+      service.
+    - d/openvswitch-switch.service: Add `Also` reference to
+      ovs-record-hostname.service so that the service is enabled on install.
+    - d/rules: Add `ovs-record-hostname.service`
+
+ -- Frode Nordahl <[e-mail]>  Tue, 16 Feb 2021 18:42:00 +0100
+
 openvswitch (2.15.0-0ubuntu1) hirsute; urgency=medium
 
   * New upstream release 2.15
diff --git a/debian/openvswitch-switch.ovs-record-hostname.service b/debian/openvswitch-switch.ovs-record-hostname.service
new file mode 100644
index 0000000..c415d13
--- /dev/null
+++ b/debian/openvswitch-switch.ovs-record-hostname.service
@@ -0,0 +1,18 @@
+[Unit]
+Description=Open vSwitch Record Hostname
+After=ovsdb-server.service ovs-vswitchd.service network-online.target
+Requires=ovsdb-server.service
+Requires=ovs-vswitchd.service
+Requires=network-online.target
+AssertPathIsReadWrite=/var/run/openvswitch/db.sock
+
+[Service]
+Type=oneshot
+ExecStart=/usr/share/openvswitch/scripts/ovs-ctl record-hostname-if-not-set
+ExecStop=/bin/true
+ExecReload=/usr/share/openvswitch/scripts/ovs-ctl record-hostname-if-not-set
+TimeoutSec=300
+RemainAfterExit=yes
+
+[Install]
+RequiredBy=openvswitch-switch.service
diff --git a/debian/openvswitch-switch.ovs-vswitchd.service b/debian/openvswitch-switch.ovs-vswitchd.service
index f2c080e..519d80d 100644
--- a/debian/openvswitch-switch.ovs-vswitchd.service
+++ b/debian/openvswitch-switch.ovs-vswitchd.service
@@ -16,9 +16,11 @@ Environment=HOME=/var/run/openvswitch
 EnvironmentFile=-/etc/default/openvswitch-switch
 ExecStart=/usr/share/openvswitch/scripts/ovs-ctl \
           --no-ovsdb-server --no-monitor --system-id=random \
+          --no-record-hostname \
           start $OVS_CTL_OPTS
 ExecStop=/usr/share/openvswitch/scripts/ovs-ctl --no-ovsdb-server stop
 ExecReload=/usr/share/openvswitch/scripts/ovs-ctl --no-ovsdb-server \
           --no-monitor --system-id=random \
+          --no-record-hostname \
           restart $OVS_CTL_OPTS
 TimeoutSec=300
diff --git a/debian/openvswitch-switch.ovsdb-server.service b/debian/openvswitch-switch.ovsdb-server.service
index 2b37229..6af3f63 100644
--- a/debian/openvswitch-switch.ovsdb-server.service
+++ b/debian/openvswitch-switch.ovsdb-server.service
@@ -12,10 +12,12 @@ Restart=on-failure
 EnvironmentFile=-/etc/default/openvswitch-switch
 ExecStart=/usr/share/openvswitch/scripts/ovs-ctl \
           --no-ovs-vswitchd --no-monitor --system-id=random \
+          --no-record-hostname \
           start $OVS_CTL_OPTS
 ExecStop=/usr/share/openvswitch/scripts/ovs-ctl --no-ovs-vswitchd stop
 ExecReload=/usr/share/openvswitch/scripts/ovs-ctl --no-ovs-vswitchd \
-           --no-monitor restart $OVS_CTL_OPTS
+          --no-record-hostname \
+          --no-monitor restart $OVS_CTL_OPTS
 RuntimeDirectory=openvswitch
 RuntimeDirectoryMode=0755
 RuntimeDirectoryPreserve=yes
diff --git a/debian/openvswitch-switch.service b/debian/openvswitch-switch.service
index f03f8b3..ef928b3 100644
--- a/debian/openvswitch-switch.service
+++ b/debian/openvswitch-switch.service
@@ -15,3 +15,4 @@ RemainAfterExit=yes
 
 [Install]
 WantedBy=multi-user.target
+Also=ovs-record-hostname.service
diff --git a/debian/patches/ovs-dev-ovs-ctl-Allow-recording-hostname-separately.patch b/debian/patches/ovs-dev-ovs-ctl-Allow-recording-hostname-separately.patch
new file mode 100644
index 0000000..a313a01
--- /dev/null
+++ b/debian/patches/ovs-dev-ovs-ctl-Allow-recording-hostname-separately.patch
@@ -0,0 +1,129 @@
+From 556e65e17991a5b165bc8697d2e4da266afada67 Mon Sep 17 00:00:00 2001
+From: Frode Nordahl <[e-mail]>
+Date: Thu, 25 Feb 2021 16:28:16 +0100
+Subject: [PATCH] ovs-ctl: Allow recording hostname separately.
+
+ovs-ctl determines the system FQDN or hostname and records it in
+the `external-ids:hostname` field of the `Open-vSwitch` table on
+system startup if it is not already set.
+
+This value may be consumed by downstream software and having it
+unset or set to a incorrect value could lead to erratic behavior
+of a system.
+
+When a system is configured to use an Open vSwitch controlled
+datapath as its only network connection, the current ordering of
+events would always record a unreliable hostname.
+
+To tackle this problem this patch adds an optional argument that
+allows starting Open vSwitch without recording the hostname in
+the database as well as a new ctl command to record the hostname
+separately. This command can be called by the system startup
+scripts when the system is ready to collect and record this
+information.
+
+Reported-At: https://bugs.launchpad.net/bugs/1915829
+Signed-off-by: Frode Nordahl <[e-mail]>
+Signed-off-by: Ilya Maximets <[e-mail]>
+Origin: https://github.com/openvswitch/ovs/commit/556e65e17991a5b165bc8697d2e4da266afada67
+Applied-Upstream: https://github.com/openvswitch/ovs/commit/2ad201659cedbb1134a9d27af132e491173c7e40
+---
+ NEWS                 |  5 +++++
+ utilities/ovs-ctl.in | 41 +++++++++++++++++++++++++++--------------
+ 2 files changed, 32 insertions(+), 14 deletions(-)
+
+diff --git a/NEWS b/NEWS
+index fb769c8194..036d4032c4 100644
+--- a/NEWS
++++ b/NEWS
+@@ -1,5 +1,10 @@
+ v2.15.1 - xx xxx xxxx
+ ---------------------
++   - ovs-ctl:
++     * New option '--no-record-hostname' to disable hostname configuration
++       in ovsdb on startup.
++     * New command 'record-hostname-if-not-set' to update hostname in ovsdb.
++
+ 
+ v2.15.0 - 15 Feb 2021
+ ---------------------
+diff --git a/utilities/ovs-ctl.in b/utilities/ovs-ctl.in
+index d71c34e691..4156da20ef 100644
+--- a/utilities/ovs-ctl.in
++++ b/utilities/ovs-ctl.in
+@@ -226,7 +226,9 @@ start_forwarding () {
+     if test X"$OVS_VSWITCHD" = Xyes; then
+         do_start_forwarding || return 1
+     fi
+-    set_hostname &
++    if test X"$RECORD_HOSTNAME" = Xyes; then
++        set_hostname &
++    fi
+     return 0
+ }
+ 
+@@ -317,6 +319,7 @@ set_defaults () {
+     SYSTEM_ID=
+ 
+     FULL_HOSTNAME=yes
++    RECORD_HOSTNAME=yes
+ 
+     DELETE_BRIDGES=no
+     DELETE_TRANSIENT_PORTS=no
+@@ -378,19 +381,24 @@ This program is intended to be invoked internally by Open vSwitch startup
+ scripts.  System administrators should not normally invoke it directly.
+ 
+ Commands:
+-  start                   start Open vSwitch daemons
+-  stop                    stop Open vSwitch daemons
+-  restart                 stop and start Open vSwitch daemons
+-  status                  check whether Open vSwitch daemons are running
+-  version                 print versions of Open vSwitch daemons
+-  load-kmod               insert modules if not already present
+-  force-reload-kmod       save OVS network device state, stop OVS, unload kernel
+-                          module, reload kernel module, start OVS, restore state
+-  enable-protocol         enable protocol specified in options with iptables
+-  delete-transient-ports  delete transient (other_config:transient=true) ports
+-  start-ovs-ipsec         start Open vSwitch ipsec daemon
+-  stop-ovs-ipsec          stop Open vSwitch ipsec daemon
+-  help                    display this help message
++  start                       start Open vSwitch daemons
++  stop                        stop Open vSwitch daemons
++  restart                     stop and start Open vSwitch daemons
++  status                      check whether Open vSwitch daemons are running
++  version                     print versions of Open vSwitch daemons
++  load-kmod                   insert modules if not already present
++  force-reload-kmod           save OVS network device state, stop OVS, unload
++                              kernel module, reload kernel module, start OVS,
++                              restore state
++  enable-protocol             enable protocol specified in options with
++                              iptables
++  delete-transient-ports      delete transient (other_config:transient=true)
++                              ports
++  start-ovs-ipsec             start Open vSwitch ipsec daemon
++  stop-ovs-ipsec              stop Open vSwitch ipsec daemon
++  record-hostname-if-not-set  determine the system hostname and record it in
++                              the Open vSwitch database if not already set
++  help                        display this help message
+ 
+ One of the following options is required for "start", "restart" and "force-reload-kmod":
+   --system-id=UUID   set specific ID to uniquely identify this system
+@@ -411,6 +419,8 @@ Less important options for "start", "restart" and "force-reload-kmod":
+   --ovsdb-server-priority=NICE   set ovsdb-server's niceness (default: $OVSDB_SERVER_PRIORITY)
+   --ovs-vswitchd-priority=NICE   set ovs-vswitchd's niceness (default: $OVS_VSWITCHD_PRIORITY)
+   --no-full-hostname             set short hostname instead of full hostname
++  --no-record-hostname           do not attempt to determine/record system
++                                 hostname as part of start command
+ 
+ Debugging options for "start", "restart" and "force-reload-kmod":
+   --ovsdb-server-wrapper=WRAPPER
+@@ -569,6 +579,9 @@ case $command in
+     stop-ovs-ipsec)
+         stop_ovs_ipsec
+         ;;
++    record-hostname-if-not-set)
++        set_hostname
++        ;;
+     help)
+         usage
+         ;;
diff --git a/debian/patches/series b/debian/patches/series
index aff3d2a..a194a4f 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
 py3-compat.patch
+ovs-dev-ovs-ctl-Allow-recording-hostname-separately.patch
diff --git a/debian/rules b/debian/rules
index d21730e..79b7106 100755
--- a/debian/rules
+++ b/debian/rules
@@ -108,9 +108,10 @@ override_dh_installinit:
 	dh_installinit --restart-after-upgrade
 	dh_installinit -popenvswitch-switch --name=ovsdb-server --no-start
 	dh_installinit -popenvswitch-switch --name=ovs-vswitchd --no-start
+	dh_installinit -popenvswitch-switch --name=ovs-record-hostname --no-start
 
 override_dh_systemd_start:
-	dh_systemd_start --restart-after-upgrade -Xovs-vswitchd.service -Xovsdb-server.service
+	dh_systemd_start --restart-after-upgrade -Xovs-vswitchd.service -Xovsdb-server.service -Xovs-record-hostname.service
 
 override_dh_strip:
 	dh_strip --dbg-package=openvswitch-dbg