Support /etc/system-update for OSTree systems

This is required when / is immutable and cannot be written at runtime.

Co-authored-by: Richard Hughes <richard@hughsie.com>

3 files changed, 32 insertions, 25 deletions

diff --git a/man/systemd-system-update-generator.xml b/man/systemd-system-update-generator.xml
index 8711be26e3..1611a71550 100644
--- a/man/systemd-system-update-generator.xml
+++ b/man/systemd-system-update-generator.xml
@@ -30,7 +30,7 @@
     <para><filename>systemd-system-update-generator</filename> is a
     generator that automatically redirects the boot process to
     <filename>system-update.target</filename>, if
-    <filename>/system-update</filename> exists. This is required to
+    <filename>/system-update</filename> or <filename>/etc/system-update</filename> exists. This is required to
     implement the logic explained in the
     <citerefentry><refentrytitle>systemd.offline-updates</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
     </para>
diff --git a/man/systemd.offline-updates.xml b/man/systemd.offline-updates.xml
index 6706451766..7285f9e263 100644
--- a/man/systemd.offline-updates.xml
+++ b/man/systemd.offline-updates.xml
@@ -40,18 +40,20 @@
       </listitem>
 
       <listitem>
-        <para>When the user OK'ed the update, the symlink <filename>/system-update</filename> is
-        created that points to <filename index="false">/var/lib/system-update</filename> (or
-        wherever the directory with the upgrade files is located) and the system is rebooted. This
-        symlink is in the root directory, since we need to check for it very early at boot, at a
-        time where <filename>/var/</filename> is not available yet.</para>
+        <para>When the user OK'ed the update, the symlink <filename>/system-update</filename> or
+        <filename>/etc/system-update</filename> is created that points to
+        <filename index="false">/var/lib/system-update</filename> (or wherever the directory with
+        the upgrade files is located) and the system is rebooted. This symlink is in the root
+        directory, since we need to check for it very early at boot, at a time where
+        <filename>/var/</filename> is not available yet.</para>
       </listitem>
 
       <listitem>
         <para>Very early in the new boot
         <citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-        checks whether <filename>/system-update</filename> exists. If so, it (temporarily and for
-        this boot only) redirects (i.e. symlinks) <filename>default.target</filename> to
+        checks whether <filename>/system-update</filename> or
+        <filename>/etc/system-update</filename> exists. If so, it (temporarily and for this boot
+        only) redirects (i.e. symlinks) <filename>default.target</filename> to
         <filename>system-update.target</filename>, a special target that pulls in the base system
         (i.e. <filename>sysinit.target</filename>, so that all file systems are mounted but little
         else) and the system update units.</para>
@@ -68,12 +70,13 @@
 
       <listitem>
         <para>As the first step, an update service should check if the
-        <filename>/system-update</filename> symlink points to the location used by that update
-        service. In case it does not exist or points to a different location, the service must exit
-        without error. It is possible for multiple update services to be installed, and for multiple
-        update services to be launched in parallel, and only the one that corresponds to the tool
-        that <emphasis>created</emphasis> the symlink before reboot should perform any actions. It
-        is unsafe to run multiple updates in parallel.</para>
+        <filename>/system-update</filename> or <filename>/etc/system-update</filename> symlink
+        points to the location used by that update service. In case it does not exist or points to a
+        different location, the service must exit without error. It is possible for multiple update
+        services to be installed, and for multiple update services to be launched in parallel, and
+        only the one that corresponds to the tool that <emphasis>created</emphasis> the symlink
+        before reboot should perform any actions. It is unsafe to run multiple updates in
+        parallel.</para>
       </listitem>
 
       <listitem>
@@ -88,14 +91,16 @@
         <para>The update scripts should exit only after the update is finished. It is expected
         that the service which performs the update will cause the machine to reboot after it
         is done. If the <filename>system-update.target</filename> is successfully reached, i.e.
-        all update services have run, and the <filename>/system-update</filename> symlink still
-        exists, it will be removed and the machine rebooted as a safety measure.</para>
+        all update services have run, and the <filename>/system-update</filename> or
+        <filename>/etc/system-update</filename> symlink still exists, it will be removed and
+        the machine rebooted as a safety measure.</para>
       </listitem>
 
       <listitem>
-        <para>After a reboot, now that the <filename>/system-update</filename> symlink is gone,
-        the generator won't redirect <filename>default.target</filename> anymore and the system
-        now boots into the default target again.</para>
+        <para>After a reboot, now that the <filename>/system-update</filename> and
+        <filename>/etc/system-update</filename> symlink is gone, the generator won't redirect
+        <filename>default.target</filename> anymore and the system now boots into the default
+        target again.</para>
       </listitem>
     </orderedlist>
   </refsect1>
@@ -115,8 +120,9 @@
       </listitem>
 
       <listitem>
-        <para>Make sure to remove the <filename>/system-update</filename> symlink as early as
-        possible in the update script to avoid reboot loops in case the update fails.</para>
+        <para>Make sure to remove the <filename>/system-update</filename> and
+        <filename>/etc/system-update</filename> symlinks as early as possible in the update
+        script to avoid reboot loops in case the update fails.</para>
       </listitem>
 
       <listitem>
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
index 85eb8ad076..1620895511 100644
--- a/man/systemd.special.xml
+++ b/man/systemd.special.xml
@@ -753,8 +753,8 @@
           <listitem>
             <para>A special target unit that is used for offline system updates.
             <citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-            will redirect the boot process to this target if <filename>/system-update</filename>
-            exists. For more information see
+            will redirect the boot process to this target if <filename>/system-update</filename> or
+            <filename>/etc/system-update</filename> exists. For more information see
             <citerefentry><refentrytitle>systemd.offline-updates</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
             </para>
 
@@ -764,9 +764,10 @@
             <filename>system-update-pre.target</filename> but not pull it in. Services which want to
             run during system updates only, but before the actual system update is executed should
             order themselves before this unit and pull it in. As a safety measure, if this does not
-            happen, and <filename>/system-update</filename> still exists after
+            happen, and <filename>/system-update</filename> or
+            <filename>/etc/system-update</filename> still exists after
             <filename>system-update.target</filename> is reached,
-            <filename>system-update-cleanup.service</filename> will remove this symlink and reboot
+            <filename>system-update-cleanup.service</filename> will remove the symlinks and reboot
             the machine.</para>
           </listitem>
         </varlistentry>