summaryrefslogtreecommitdiffstats
path: root/man/systemd-volatile-root.service.xml
blob: 0d3b40211aa030606bdf150d6039b83afc29eeb7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-volatile-root.service">

  <refentryinfo>
    <title>systemd-volatile-root.service</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-volatile-root.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-volatile-root.service</refname>
    <refname>systemd-volatile-root</refname>
    <refpurpose>Make the root file system volatile</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-volatile-root.service</filename></para>
    <para><filename>/usr/lib/systemd/systemd-volatile-root</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-volatile-root.service</filename> is a service that replaces the root directory with a
    volatile memory file system (<literal>tmpfs</literal>), mounting the original (non-volatile)
    <filename>/usr/</filename> inside it read-only. This way, vendor data from <filename>/usr/</filename> is available as
    usual, but all configuration data in <filename>/etc/</filename>, all state data in <filename>/var/</filename> and all
    other resources stored directly under the root directory are reset on boot and lost at shutdown, enabling fully
    stateless systems.</para>

    <para>This service is only enabled if full volatile mode is selected, for example by specifying
    <literal>systemd.volatile=yes</literal> on the kernel command line. This service runs only in the initrd,
    before the system transitions to the host's root directory. Note that this service is not used if
    <literal>systemd.volatile=state</literal> is used, as in that mode the root directory is non-volatile.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>