Skip to content

Commit

Permalink
Merge pull request #367 from SUSE/jhalackova_PED-8686
Browse files Browse the repository at this point in the history
Jhalackova ped 8686
  • Loading branch information
lvicoun authored Oct 14, 2024
2 parents 9692077 + c49c322 commit b5b50d9
Show file tree
Hide file tree
Showing 8 changed files with 146 additions and 56 deletions.
2 changes: 1 addition & 1 deletion DC-Micro-transactional-updates
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ SRC_DIR="articles"
IMG_SRC_DIR="images"
PROFOS="slmicro"

PROFCONDITION="suse-product"
PROFCONDITION="6.1"
#PROFCONDITION="suse-product;beta"

STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
Expand Down
17 changes: 0 additions & 17 deletions DC-SLE-Micro-5.4-admin

This file was deleted.

17 changes: 0 additions & 17 deletions DC-SLE-Micro-5.5-admin

This file was deleted.

17 changes: 0 additions & 17 deletions DC-SLE-Micro-admin

This file was deleted.

13 changes: 12 additions & 1 deletion articles/transactional-updates.asm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@
<resource xml:id="_transactional-update-usage" href="../references/transactional-update-usage.xml">
<description>Usage of &tr-up;</description>
</resource>
<resource xml:id="_transactional-update-performing-soft-reboot" href="../references/transactional-update-performing-soft-reboot.xml">
<description>soft-reboot configuration</description>
</resource>
</resources>
<!-- Legal -->
<resources>
Expand Down Expand Up @@ -171,7 +174,15 @@
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_transactional-update" renderas="section"/>
<module resourceref="_transactional-update-usage" renderas="section"/>
<module resourceref="_transactional-update-usage" renderas="section">
<module resourceref="_transactional-update-performing-soft-reboot">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module resourceref="_transactional-update-no-reboot" renderas="section">
<merge>
<title>Applying multiple changes without rebooting</title>
Expand Down
10 changes: 10 additions & 0 deletions references/systemctl-cheatsheet.xml
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry os="slmicro">
<term>systemctl soft-reboot</term>
<listitem>
<para>
The command reboots only the user space. It shuts down all services and units, restarts &systemd;
and starts all &systemd; services again. It can also switch to a new root file system.
On the contrary, hardware, kernel space and initrd are <emphasis>not</emphasis> restarted.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</topic>
115 changes: 115 additions & 0 deletions references/transactional-update-performing-soft-reboot.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="transactional-update-soft-reboot"
role="reference" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Configuration of <command>soft-reboot</command></title><!-- can be changed via merge in the assembly -->
<!--add author's email address-->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract><!-- can be changed via merge in the assembly -->
<para>
The topic describes how to enable soft-reboot and how to define when a regular
reboot is needed.
</para>
</abstract>
</info>
<section xml:id="transactional-update-soft-reboot-enabling">
<title>Enabling/disabling <command>soft-reboot</command></title>
<para>
To enable <command>soft-reboot</command> on &tr-up;, proceed as follows:
</para>
<procedure>
<step>
<para>
Create a directory <filename>/etc/tukit.conf.d/</filename>
</para>
<screen>&prompt.sudo;mkdir /etc/tukit.conf.d/</screen>
</step>
<step>
<para>
Create a file <filename>/etc/tukit.conf.d/soft-reboot.conf</filename> with the following content:
</para>
<screen>REBOOT_ALLOW_SOFT_REBOOT=true</screen>
<para>
For example, by running the following command:
</para>
<screen>&prompt.sudo;echo "REBOOT_ALLOW_SOFT_REBOOT=true" > /etc/tukit.conf.d/soft-reboot.conf</screen>
</step>
</procedure>
<para>
To disable <command>soft-reboot</command>, change <literal>true</literal> to
<literal>false</literal> in the <filename>/etc/tukit.conf.d/soft-reboot.conf</filename> file.
</para>
</section>
<section xml:id="transactional-update-soft-reboot-packages">
<title>Configuration of <command>soft-reboot</command></title>
<para>
You can define which packages require specific types of reboots
in the <filename>/usr/etc/zypp/zypp-boot-plugin.conf</filename> file. To make changes, copy this
file to <filename>/etc/zypp/zypp-boot-plugin.conf</filename>, which is writable and is not
replaced during updates. The <filename>/etc/zypp/zypp-boot-plugin.conf</filename> file
also has a higher priority than <filename>/usr/etc/zypp/zypp-boot-plugin.conf</filename>,
so your configuration is preferred to the default one.
</para>
<para>
In the <filename>/etc/zypp/zypp-boot-plugin.conf</filename> file, under the
<literal>[main]</literal> section, there are three reboot options:
</para>
<variablelist>
<varlistentry>
<term>reboot</term>
<listitem>
<para>
Here you specify the packages that require a hardware reboot when they are changed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>kexec</term>
<listitem>
<para>
Provides a list of packages whose changes require a kernel reboot. However,
a hardware reboot does not take place, and GRUB2 is not triggered.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>soft-reboot</term>
<listitem>
<para>
Specifies packages whose changes only require a reboot of the user space.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Entries can be a comma-separated list of package names or a list of all
packages that provide a particular application or system component.
Regular expressions can also be used. Here is an example:
</para>
<screen>
soft-reboot = glibc, dbus-broker
</screen>
<para>
Or using the <literal>provides</literal> statement:
</para>
<screen>
soft-reboot = provides: dbus
</screen>
</section>
</topic>
11 changes: 8 additions & 3 deletions references/transactional-update-usage.xml
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,14 @@ transactional-update <option>[option]</option> <replaceable>[general_command]</r
</varlistentry>
<varlistentry>
<term><command>reboot</command></term>
<listitem>
<listitem>
<para>
The system reboots after the &tr-up; command is complete.
The behavior of <command>reboot</command> depends on the
configuration and changes performed to the system. If
<command>soft-reboot</command> is enabled, only the user
space may be restarted without rebooting the hardware and kernel.
The enabling and configuration of <command>soft-reboot</command>
are described in <xref linkend="transactional-update-soft-reboot"/>.
</para>
</listitem>
</varlistentry>
Expand All @@ -189,7 +194,7 @@ transactional-update <option>[option]</option> <replaceable>[general_command]</r
</para>
</listitem>
</varlistentry>
<varlistentry os="slmicro">
<varlistentry>
<term><command>setup-fips</command></term>
<listitem>
<para>
Expand Down

0 comments on commit b5b50d9

Please sign in to comment.