Skip to content

Commit

Permalink
Removed techpreview info + minor stylish updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tbazant committed Jun 22, 2023
1 parent 5c8ca24 commit ca6bb53
Showing 1 changed file with 31 additions and 29 deletions.
60 changes: 31 additions & 29 deletions xml/transactional_updates.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,22 @@
</dm:docmanager>
<abstract>
<para>
Transactional updates are available in &productname; as a technology
preview, for updating &slsa; when the root file system is read-only.
Transactional updates are atomic (all updates are applied only if all
updates succeed) and support rollbacks. It does not affect a running system
as no changes are activated until after the system is rebooted. As reboots
are disruptive, the administrator must decide if a reboot is more expensive than
disturbing running services. If reboots are too expensive then do not use
transactional updates.
Transactional updates are available in &productname; for updating &slsa;
when the root file system is read-only. Transactional updates are
atomic&mdash;all updates are applied only if all succeed&mdash;and support
rollbacks. It does not affect a running system as no changes are activated
until after the system is rebooted. As reboots are disruptive, the
administrator must decide if a reboot is more expensive than disturbing
running services. If reboots are too expensive then do not use transactional
updates.
</para>

<para>
Transactional updates are run daily by the
<command>transactional-update</command> script. The script checks for
available updates. If there are any updates, it creates a new snapshot of
the root file system in the background, and then fetches updates from the
release channels. After the new snapshot is completely updated, it is
release channels. After the new snapshot is updated, it is
marked as active and will be the new default root file system after the next
reboot of the system. When <command>transactional-update</command> is set to run
automatically (which is the default behavior) it also reboots the system.
Expand All @@ -52,17 +52,19 @@
</info>

<sect1 xml:id="sec-tu-limitations">
<title>Limitations of technology preview</title>
<title>Limitations</title>

<para>
As a technology preview, there are certain limitations in functionality. The
following packages will not work with <command>transactional-update</command>:
Currently, there are certain limitations in the functionality of
transactional updates. The following packages do not work with the
<command>transactional-update</command> command:
</para>

<itemizedlist>
<listitem>
<para>
The <package>nginx</package> default index.html page may not be available
The <package>nginx</package> default <filename>index.html</filename> page
may not be available
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -191,9 +193,9 @@
<listitem>
<para>
&yast; is not yet aware of transactional updates. If a YaST module needs
to install additional packages, this will not work. Normal system
operations only modifying configuration files in <filename>/etc</filename>
will work.
to install additional packages, this does not work. Normal system
operations that modify configuration files in <filename>/etc</filename>
work.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -253,10 +255,10 @@
</para>
<para>
Changing the subvolume layout of the root partition, or putting
sub-directories or subvolumes of the root partition on their own partitions
subdirectories or subvolumes of the root partition on their own partitions
(except <filename>/home</filename>, <filename>/var</filename>,
<filename>/srv</filename>, and <filename>/opt</filename>) is not supported,
and will most probably break the system.
and may break the system.
</para>
</sect1>

Expand All @@ -280,9 +282,9 @@
<sect1>
<title>The <command>transactional-update</command> command</title>
<para>
The <command>transactional-update</command> command enables atomic installation
or removal of updates; updates are applied only
if all of them can be successfully installed.
The <command>transactional-update</command> command enables atomic
installation or removal of updates. Updates are applied only if they all can
be successfully installed.
<command>transactional-update</command> creates a snapshot of your system
before the update is applied, and you can restore this snapshot. All changes become
active only after reboot.
Expand Down Expand Up @@ -335,11 +337,11 @@
<para>
If the current root file system is identical to the active root
file system (after a reboot, before <command>transactional-update</command>
creates a new snapshot with updates), all old snapshots without a
cleanup algorithm get a cleanup algorithm set. This ensures that old
snapshots will be deleted by Snapper. (See the section about cleanup
algorithms in snapper(8).) This also removes all unreferenced (and thus
unused) <filename>/etc</filename> overlay directories in
creates a new snapshot with updates), all old snapshots without a cleanup
algorithm get a cleanup algorithm set. This ensures that old snapshots are
deleted by Snapper. (See the section about cleanup algorithms in
snapper(8).) This also removes all unreferenced (and thus unused)
<filename>/etc</filename> overlay directories in
<filename>/var/lib/overlay</filename>:
</para>
<screen>&prompt.root;<command>transactional-update cleanup</command></screen>
Expand Down Expand Up @@ -433,12 +435,12 @@
<listitem>
<para>
This creates a new GRUB2 configuration. Sometimes it is necessary to
adjust the boot configuration, for example adding additional kernel
adjust the boot configuration, for example, adding additional kernel
parameters. Edit <replaceable>/etc/default/grub</replaceable>, run
<command>transactional-update grub.cfg</command>, and then reboot to
activate the change. You must immediately reboot, or the new GRUB2
configuration will be overwritten with the default by the next
transactional-update.
configuration gets overwritten with the default by the next
<command>transactional-update</command> run.
</para>
<screen>&prompt.root;<command>transactional-update grub.cfg</command></screen>
</listitem>
Expand Down

0 comments on commit ca6bb53

Please sign in to comment.