2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
6 <refentry id=
"repart.d" conditional='ENABLE_REPART'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>repart.d
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>repart.d
</refentrytitle>
16 <manvolnum>5</manvolnum>
20 <refname>repart.d
</refname>
21 <refpurpose>Partition Definition Files for Automatic Boot-Time Repartitioning
</refpurpose>
25 <para><literallayout><filename>/etc/repart.d/*.conf
</filename>
26 <filename>/run/repart.d/*.conf
</filename>
27 <filename>/usr/lib/repart.d/*.conf
</filename>
28 </literallayout></para>
32 <title>Description
</title>
34 <para><filename>repart.d/*.conf
</filename> files describe basic properties of partitions of block
35 devices of the local system. They may be used to declare types, names and sizes of partitions that shall
37 <citerefentry><refentrytitle>systemd-repart
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
38 service reads these files and attempts to add new partitions currently missing and enlarge existing
39 partitions according to these definitions. Operation is generally incremental, i.e. when applied, what
40 exists already is left intact, and partitions are never shrunk, moved or deleted.
</para>
42 <para>These definition files are useful for implementing operating system images that are prepared and
43 delivered with minimally sized images (for example lacking any state or swap partitions), and which on
44 first boot automatically take possession of any remaining disk space following a few basic rules.
</para>
46 <para>Currently, support for partition definition files is only implemented for GPT partitition
49 <para>Partition files are generally matched against any partitions already existing on disk in a simple
50 algorithm: the partition files are sorted by their filename (ignoring the directory prefix), and then
51 compared in order against existing partitions matching the same partition type UUID. Specifically, the
52 first existing partition with a specific partition type UUID is assigned the first definition file with
53 the same partition type UUID, and the second existing partition with a specific type UUID the second
54 partition file with the same type UUID, and so on. Any left-over partition files that have no matching
55 existing partition are assumed to define new partition that shall be created. Such partitions are
56 appended to the end of the partition table, in the order defined by their names utilizing the first
57 partition slot greater than the highest slot number currently in use. Any existing partitions that have
58 no matching partition file are left as they are.
</para>
60 <para>Note that these definitions may only be used to create and initialize new partitions or to grow
61 existing ones. In the latter case it will not grow the contained files systems however; separate
63 <citerefentry><refentrytitle>systemd-growfs
</refentrytitle><manvolnum>8</manvolnum></citerefentry> may be
64 used to grow the file systems inside of these partitions. Partitions may also be marked for automatic
65 growing via the
<varname>GrowFileSystem=
</varname> setting, in which case the file system is grown on
66 first mount by tools that respect this flag. See below for details.
</para>
70 <title>[Partition] Section Options
</title>
74 <term><varname>Type=
</varname></term>
76 <listitem><para>The GPT partition type UUID to match. This may be a GPT partition type UUID such as
77 <constant>4f68bce3-e8cd-
4db1-
96e7-fbcaf984b709
</constant>, or an identifier.
78 Architecture specific partition types can use one of these architecture identifiers:
79 <constant>alpha
</constant>,
<constant>arc
</constant>,
<constant>arm
</constant> (
32bit),
80 <constant>arm64
</constant> (
64bit, aka aarch64),
<constant>ia64
</constant>,
81 <constant>loongarch64
</constant>,
<constant>mips-le
</constant>,
<constant>mips64-le
</constant>,
82 <constant>parisc
</constant>,
<constant>ppc
</constant>,
<constant>ppc64
</constant>,
83 <constant>ppc64-le
</constant>,
<constant>riscv32
</constant>,
<constant>riscv64
</constant>,
84 <constant>s390
</constant>,
<constant>s390x
</constant>,
<constant>tilegx
</constant>,
85 <constant>x86
</constant> (
32bit, aka i386) and
<constant>x86-
64</constant> (
64bit, aka amd64).
87 The supported identifiers are:
</para>
90 <title>GPT partition type identifiers
</title>
92 <tgroup cols='
2' align='left' colsep='
1' rowsep='
1'
>
93 <colspec colname=
"name" />
94 <colspec colname=
"explanation" />
98 <entry>Identifier
</entry>
99 <entry>Explanation
</entry>
105 <entry><constant>esp
</constant></entry>
106 <entry>EFI System Partition
</entry>
110 <entry><constant>xbootldr
</constant></entry>
111 <entry>Extended Boot Loader Partition
</entry>
115 <entry><constant>swap
</constant></entry>
116 <entry>Swap partition
</entry>
120 <entry><constant>home
</constant></entry>
121 <entry>Home (
<filename>/home/
</filename>) partition
</entry>
125 <entry><constant>srv
</constant></entry>
126 <entry>Server data (
<filename>/srv/
</filename>) partition
</entry>
130 <entry><constant>var
</constant></entry>
131 <entry>Variable data (
<filename>/var/
</filename>) partition
</entry>
135 <entry><constant>tmp
</constant></entry>
136 <entry>Temporary data (
<filename>/var/tmp/
</filename>) partition
</entry>
140 <entry><constant>linux-generic
</constant></entry>
141 <entry>Generic Linux file system partition
</entry>
145 <entry><constant>root
</constant></entry>
146 <entry>Root file system partition type appropriate for the local architecture (an alias for an architecture root file system partition type listed below, e.g.
<constant>root-x86-
64</constant>)
</entry>
150 <entry><constant>root-verity
</constant></entry>
151 <entry>Verity data for the root file system partition for the local architecture
</entry>
155 <entry><constant>root-verity-sig
</constant></entry>
156 <entry>Verity signature data for the root file system partition for the local architecture
</entry>
160 <entry><constant>root-secondary
</constant></entry>
161 <entry>Root file system partition of the secondary architecture of the local architecture (usually the matching
32bit architecture for the local
64bit architecture)
</entry>
165 <entry><constant>root-secondary-verity
</constant></entry>
166 <entry>Verity data for the root file system partition of the secondary architecture
</entry>
170 <entry><constant>root-secondary-verity-sig
</constant></entry>
171 <entry>Verity signature data for the root file system partition of the secondary architecture
</entry>
175 <entry><constant>root-{arch}
</constant></entry>
176 <entry>Root file system partition of the given architecture (such as
<constant>root-x86-
64</constant> or
<constant>root-riscv64
</constant>)
</entry>
180 <entry><constant>root-{arch}-verity
</constant></entry>
181 <entry>Verity data for the root file system partition of the given architecture
</entry>
185 <entry><constant>root-{arch}-verity-sig
</constant></entry>
186 <entry>Verity signature data for the root file system partition of the given architecture
</entry>
190 <entry><constant>usr
</constant></entry>
191 <entry><filename>/usr/
</filename> file system partition type appropriate for the local architecture (an alias for an architecture
<filename>/usr/
</filename> file system partition type listed below, e.g.
<constant>usr-x86-
64</constant>)
</entry>
195 <entry><constant>usr-verity
</constant></entry>
196 <entry>Verity data for the
<filename>/usr/
</filename> file system partition for the local architecture
</entry>
200 <entry><constant>usr-verity-sig
</constant></entry>
201 <entry>Verity signature data for the
<filename>/usr/
</filename> file system partition for the local architecture
</entry>
205 <entry><constant>usr-secondary
</constant></entry>
206 <entry><filename>/usr/
</filename> file system partition of the secondary architecture of the local architecture (usually the matching
32bit architecture for the local
64bit architecture)
</entry>
210 <entry><constant>usr-secondary-verity
</constant></entry>
211 <entry>Verity data for the
<filename>/usr/
</filename> file system partition of the secondary architecture
</entry>
215 <entry><constant>usr-secondary-verity-sig
</constant></entry>
216 <entry>Verity signature data for the
<filename>/usr/
</filename> file system partition of the secondary architecture
</entry>
220 <entry><constant>usr-{arch}
</constant></entry>
221 <entry><filename>/usr/
</filename> file system partition of the given architecture
</entry>
225 <entry><constant>usr-{arch}-verity
</constant></entry>
226 <entry>Verity data for the
<filename>/usr/
</filename> file system partition of the given architecture
</entry>
230 <entry><constant>usr-{arch}-verity-sig
</constant></entry>
231 <entry>Verity signature data for the
<filename>/usr/
</filename> file system partition of the given architecture
</entry>
237 <para>This setting defaults to
<constant>linux-generic
</constant>.
</para>
239 <para>Most of the partition type UUIDs listed above are defined in the
<ulink
240 url=
"https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
241 Specification
</ulink>.
</para></listitem>
245 <term><varname>Label=
</varname></term>
247 <listitem><para>The textual label to assign to the partition if none is assigned yet. Note that this
248 setting is not used for matching. It is also not used when a label is already set for an existing
249 partition. It is thus only used when a partition is newly created or when an existing one had a no
250 label set (that is: an empty label). If not specified a label derived from the partition type is
251 automatically used. Simple specifier expansion is supported, see below.
</para></listitem>
255 <term><varname>UUID=
</varname></term>
257 <listitem><para>The UUID to assign to the partition if none is assigned yet. Note that this
258 setting is not used for matching. It is also not used when a UUID is already set for an existing
259 partition. It is thus only used when a partition is newly created or when an existing one had a
260 all-zero UUID set. If set to
<literal>null
</literal>, the UUID is set to all zeroes. If not specified
261 a UUID derived from the partition type is automatically used.
</para></listitem>
265 <term><varname>Priority=
</varname></term>
267 <listitem><para>A numeric priority to assign to this partition, in the range -
2147483648…
2147483647,
268 with smaller values indicating higher priority, and higher values indicating smaller priority. This
269 priority is used in case the configured size constraints on the defined partitions do not permit
270 fitting all partitions onto the available disk space. If the partitions do not fit, the highest
271 numeric partition priority of all defined partitions is determined, and all defined partitions with
272 this priority are removed from the list of new partitions to create (which may be multiple, if the
273 same priority is used for multiple partitions). The fitting algorithm is then tried again. If the
274 partitions still do not fit, the now highest numeric partition priority is determined, and the
275 matching partitions removed too, and so on. Partitions of a priority of
0 or lower are never
276 removed. If all partitions with a priority above
0 are removed and the partitions still do not fit on
277 the device the operation fails. Note that this priority has no effect on ordering partitions, for
278 that use the alphabetical order of the filenames of the partition definition files. Defaults to
283 <term><varname>Weight=
</varname></term>
285 <listitem><para>A numeric weight to assign to this partition in the range
0…
1000000. Available disk
286 space is assigned the defined partitions according to their relative weights (subject to the size
287 constraints configured with
<varname>SizeMinBytes=
</varname>,
<varname>SizeMaxBytes=
</varname>), so
288 that a partition with weight
2000 gets double the space as one with weight
1000, and a partition with
289 weight
333 a third of that. Defaults to
1000.
</para>
291 <para>The
<varname>Weight=
</varname> setting is used to distribute available disk space in an
292 "elastic" fashion, based on the disk size and existing partitions. If a partition shall have a fixed
293 size use both
<varname>SizeMinBytes=
</varname> and
<varname>SizeMaxBytes=
</varname> with the same
294 value in order to fixate the size to one value, in which case the weight has no
295 effect.
</para></listitem>
299 <term><varname>PaddingWeight=
</varname></term>
301 <listitem><para>Similar to
<varname>Weight=
</varname>, but sets a weight for the free space after the
302 partition (the
"padding"). When distributing available space the weights of all partitions and all
303 defined padding is summed, and then each partition and padding gets the fraction defined by its
304 weight. Defaults to
0, i.e. by default no padding is applied.
</para>
306 <para>Padding is useful if empty space shall be left for later additions or a safety margin at the
307 end of the device or between partitions.
</para></listitem>
311 <term><varname>SizeMinBytes=
</varname></term>
312 <term><varname>SizeMaxBytes=
</varname></term>
314 <listitem><para>Specifies minimum and maximum size constraints in bytes. Takes the usual K, M, G, T,
315 … suffixes (to the base of
1024). If
<varname>SizeMinBytes=
</varname> is specified the partition is
316 created at or grown to at least the specified size. If
<varname>SizeMaxBytes=
</varname> is specified
317 the partition is created at or grown to at most the specified size. The precise size is determined
318 through the weight value configured with
<varname>Weight=
</varname>, see above. When
319 <varname>SizeMinBytes=
</varname> is set equal to
<varname>SizeMaxBytes=
</varname> the configured
320 weight has no effect as the partition is explicitly sized to the specified fixed value. Note that
321 partitions are never created smaller than
4096 bytes, and since partitions are never shrunk the
322 previous size of the partition (in case the partition already exists) is also enforced as lower bound
323 for the new size. The values should be specified as multiples of
4096 bytes, and are rounded upwards
324 (in case of
<varname>SizeMinBytes=
</varname>) or downwards (in case of
325 <varname>SizeMaxBytes=
</varname>) otherwise. If the backing device does not provide enough space to
326 fulfill the constraints placing the partition will fail. For partitions that shall be created,
327 depending on the setting of
<varname>Priority=
</varname> (see above) the partition might be dropped
328 and the placing algorithm restarted. By default a minimum size constraint of
10M and no maximum size
329 constraint is set.
</para></listitem>
333 <term><varname>PaddingMinBytes=
</varname></term>
334 <term><varname>PaddingMaxBytes=
</varname></term>
336 <listitem><para>Specifies minimum and maximum size constraints in bytes for the free space after the
337 partition (the
"padding"). Semantics are similar to
<varname>SizeMinBytes=
</varname> and
338 <varname>SizeMaxBytes=
</varname>, except that unlike partition sizes free space can be shrunk and can
339 be as small as zero. By default no size constraints on padding are set, so that only
340 <varname>PaddingWeight=
</varname> determines the size of the padding applied.
</para></listitem>
344 <term><varname>CopyBlocks=
</varname></term>
346 <listitem><para>Takes a path to a regular file, block device node or directory, or the special value
347 <literal>auto
</literal>. If specified and the partition is newly created, the data from the specified
348 path is written to the newly created partition, on the block level. If a directory is specified, the
349 backing block device of the file system the directory is on is determined, and the data read directly
350 from that. This option is useful to efficiently replicate existing file systems onto new partitions
351 on the block level — for example to build a simple OS installer or an OS image builder.
</para>
353 <para>If the special value
<literal>auto
</literal> is specified, the source to copy from is
354 automatically picked up from the running system (or the image specified with
355 <option>--image=
</option> — if used). A partition that matches both the configured partition type (as
356 declared with
<varname>Type=
</varname> described above), and the currently mounted directory
357 appropriate for that partition type is determined. For example, if the partition type is set to
358 <literal>root
</literal> the partition backing the root directory (
<filename>/
</filename>) is used as
359 source to copy from — if its partition type is set to
<literal>root
</literal> as well. If the
360 declared type is
<literal>usr
</literal> the partition backing
<filename>/usr/
</filename> is used as
361 source to copy blocks from — if its partition type is set to
<literal>usr
</literal> too. The logic is
362 capable of automatically tracking down the backing partitions for encrypted and Verity-enabled
363 volumes.
<literal>CopyBlocks=auto
</literal> is useful for implementing
"self-replicating" systems,
364 i.e. systems that are their own installer.
</para>
366 <para>The file specified here must have a size that is a multiple of the basic block size
512 and not
367 be empty. If this option is used, the size allocation algorithm is slightly altered: the partition is
368 created as least as big as required to fit the data in, i.e. the data size is an additional minimum
369 size value taken into consideration for the allocation algorithm, similar to and in addition to the
370 <varname>SizeMin=
</varname> value configured above.
</para>
372 <para>This option has no effect if the partition it is declared for already exists, i.e. existing
373 data is never overwritten. Note that the data is copied in before the partition table is updated,
374 i.e. before the partition actually is persistently created. This provides robustness: it is
375 guaranteed that the partition either doesn't exist or exists fully populated; it is not possible that
376 the partition exists but is not or only partially populated.
</para>
378 <para>This option cannot be combined with
<varname>Format=
</varname> or
379 <varname>CopyFiles=
</varname>.
</para></listitem>
383 <term><varname>Format=
</varname></term>
385 <listitem><para>Takes a file system name, such as
<literal>ext4
</literal>,
<literal>btrfs
</literal>,
386 <literal>xfs
</literal>,
<literal>vfat
</literal>,
<literal>squashfs
</literal>, or the special value
387 <literal>swap
</literal>. If specified and the partition is newly created it is formatted with the
388 specified file system (or as swap device). The file system UUID and label are automatically derived
389 from the partition UUID and label. If this option is used, the size allocation algorithm is slightly
390 altered: the partition is created as least as big as required for the minimal file system of the
391 specified type (or
4KiB if the minimal size is not known).
</para>
393 <para>This option has no effect if the partition already exists.
</para>
395 <para>Similarly to the behaviour of
<varname>CopyBlocks=
</varname>, the file system is formatted
396 before the partition is created, ensuring that the partition only ever exists with a fully
397 initialized file system.
</para>
399 <para>This option cannot be combined with
<varname>CopyBlocks=
</varname>.
</para></listitem>
403 <term><varname>CopyFiles=
</varname></term>
405 <listitem><para>Takes a pair of colon separated absolute file system paths. The first path refers to
406 a source file or directory on the host, the second path refers to a target in the file system of the
407 newly created partition and formatted file system. This setting may be used to copy files or
408 directories from the host into the file system that is created due to the
<varname>Format=
</varname>
409 option. If
<varname>CopyFiles=
</varname> is used without
<varname>Format=
</varname> specified
410 explicitly,
<literal>Format=
</literal> with a suitable default is implied (currently
411 <literal>ext4
</literal>, but this may change in the future). This option may be used multiple times
412 to copy multiple files or directories from host into the newly formatted file system. The colon and
413 second path may be omitted in which case the source path is also used as the target path (relative to
414 the root of the newly created file system). If the source path refers to a directory it is copied
417 <para>This option has no effect if the partition already exists: it cannot be used to copy additional
418 files into an existing partition, it may only be used to populate a file system created anew.
</para>
420 <para>The copy operation is executed before the file system is registered in the partition table,
421 thus ensuring that a file system populated this way only ever exists fully initialized.
</para>
423 <para>This option cannot be combined with
<varname>CopyBlocks=
</varname>.
</para>
425 <para>When
<command>systemd-repart
</command> is invoked with the
<option>--image=
</option> or
426 <option>--root=
</option> command line switches the source paths specified are taken relative to the
427 specified root directory or disk image root.
</para></listitem>
431 <term><varname>MakeDirectories=
</varname></term>
433 <listitem><para>Takes one or more absolute paths, separated by whitespace, each declaring a directory
434 to create within the new file system. Behaviour is similar to
<varname>CopyFiles=
</varname>, but
435 instead of copying in a set of files this just creates the specified directories with the default
436 mode of
0755 owned by the root user and group, plus all their parent directories (with the same
437 ownership and access mode). To configure directories with different ownership or access mode, use
438 <varname>CopyFiles=
</varname> and specify a source tree to copy containing appropriately
439 owned/configured directories. This option may be used more than once to create multiple
440 directories. When
<varname>CopyFiles=
</varname> and
<varname>MakeDirectories=
</varname> are used
441 together the former is applied first. If a directory listed already exists no operation is executed
442 (in particular, the ownership/access mode of the directories is left as is).
</para>
444 <para>The primary usecase for this option is to create a minimal set of directories that may be
445 mounted over by other partitions contained in the same disk image. For example, a disk image where
446 the root file system is formatted at first boot might want to automatically pre-create
447 <filename>/usr/
</filename> in it this way, so that the
<literal>usr
</literal> partition may
448 over-mount it.
</para>
451 <citerefentry><refentrytitle>systemd-tmpfiles
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
452 with its
<option>--image=
</option> option to pre-create other, more complex directory hierarchies (as
453 well as other inodes) with fine-grained control of ownership, access modes and other file
454 attributes.
</para></listitem>
458 <term><varname>Encrypt=
</varname></term>
460 <listitem><para>Takes one of
<literal>off
</literal>,
<literal>key-file
</literal>,
461 <literal>tpm2
</literal> and
<literal>key-file+tpm2
</literal> (alternatively, also accepts a boolean
462 value, which is mapped to
<literal>off
</literal> when false, and
<literal>key-file
</literal> when
463 true). Defaults to
<literal>off
</literal>. If not
<literal>off
</literal> the partition will be
464 formatted with a LUKS2 superblock, before the blocks configured with
<varname>CopyBlocks=
</varname>
465 are copied in or the file system configured with
<varname>Format=
</varname> is created.
</para>
467 <para>The LUKS2 UUID is automatically derived from the partition UUID in a stable fashion. If
468 <literal>key-file
</literal> or
<literal>key-file+tpm2
</literal> is used, a key is added to the LUKS2
469 superblock, configurable with the
<option>--key-file=
</option> option to
470 <command>systemd-repart
</command>. If
<literal>tpm2
</literal> or
<literal>key-file+tpm2
</literal> is
471 used, a key is added to the LUKS2 superblock that is enrolled to the local TPM2 chip, as configured
472 with the
<option>--tpm2-device=
</option> and
<option>--tpm2-pcrs=
</option> options to
473 <command>systemd-repart
</command>.
</para>
475 <para>When used this slightly alters the size allocation logic as the implicit, minimal size limits
476 of
<varname>Format=
</varname> and
<varname>CopyBlocks=
</varname> are increased by the space necessary
477 for the LUKS2 superblock (see above).
</para>
479 <para>This option has no effect if the partition already exists.
</para></listitem>
483 <term><varname>Verity=
</varname></term>
485 <listitem><para>Takes one of
<literal>off
</literal>,
<literal>data
</literal>,
486 <literal>hash
</literal> or
<literal>signature
</literal>. Defaults to
<literal>off
</literal>. If set
487 to
<literal>off
</literal> or
<literal>data
</literal>, the partition is populated with content as
488 specified by
<varname>CopyBlocks=
</varname> or
<varname>CopyFiles=
</varname>. If set to
489 <literal>hash
</literal>, the partition will be populated with verity hashes from the matching verity
490 data partition. If set to
<literal>signature
</literal>, The partition will be populated with a JSON
491 object containing a signature of the verity root hash of the matching verity hash partition.
</para>
493 <para>A matching verity partition is a partition with the same verity match key (as configured with
494 <varname>VerityMatchKey=
</varname>).
</para>
496 <para>If not explicitly configured, the data partition's UUID will be set to the first
128
497 bits of the verity root hash. Similarly, if not configured, the hash partition's UUID will be set to
498 the final
128 bits of the verity root hash. The verity root hash itself will be included in the
499 output of
<command>systemd-repart
</command>.
</para>
501 <para>This option has no effect if the partition already exists.
</para>
503 <para>Usage of this option in combination with
<varname>Encrypt=
</varname> is not supported.
</para>
505 <para>For each unique
<varname>VerityMatchKey=
</varname> value, a single verity data partition
506 (
<literal>Verity=data
</literal>) and a single verity hash partition (
<literal>Verity=hash
</literal>)
507 must be defined.
</para></listitem>
511 <term><varname>VerityMatchKey=
</varname></term>
513 <listitem><para>Takes a short, user-chosen identifier string. This setting is used to find sibling
514 verity partitions for the current verity partition. See the description for
515 <varname>Verity=
</varname>.
</para></listitem>
519 <term><varname>FactoryReset=
</varname></term>
521 <listitem><para>Takes a boolean argument. If specified the partition is marked for removal during a
522 factory reset operation. This functionality is useful to implement schemes where images can be reset
523 into their original state by removing partitions and creating them anew. Defaults to off.
</para></listitem>
527 <term><varname>Flags=
</varname></term>
529 <listitem><para>Configures the
64bit GPT partition flags field to set for the partition when creating
530 it. This option has no effect if the partition already exists. If not specified the flags values is
531 set to all zeroes, except for the three bits that can also be configured via
532 <varname>NoAuto=
</varname>,
<varname>ReadOnly=
</varname> and
<varname>GrowFileSystem=
</varname>; see
533 below for details on the defaults for these three flags. Specify the flags value in hexadecimal (by
534 prefixing it with
<literal>0x
</literal>), binary (prefix
<literal>0b
</literal>) or decimal (no
535 prefix).
</para></listitem>
539 <term><varname>NoAuto=
</varname></term>
540 <term><varname>ReadOnly=
</varname></term>
541 <term><varname>GrowFileSystem=
</varname></term>
543 <listitem><para>Configures the No-Auto, Read-Only and Grow-File-System partition flags (bit
63,
60
544 and
59) of the partition table entry, as defined by the
<ulink
545 url=
"https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification
</ulink>. Only
546 available for partition types supported by the specification. This option is a friendly way to set
547 bits
63,
60 and
59 of the partition flags value without setting any of the other bits, and may be set
548 via
<varname>Flags=
</varname> too, see above.
</para>
550 <para>If
<varname>Flags=
</varname> is used in conjunction with one or more of
551 <varname>NoAuto=
</varname>/
<varname>ReadOnly=
</varname>/
<varname>GrowFileSystem=
</varname> the latter
552 control the value of the relevant flags, i.e. the high-level settings
553 <varname>NoAuto=
</varname>/
<varname>ReadOnly=
</varname>/
<varname>GrowFileSystem=
</varname> override
554 the relevant bits of the low-level setting
<varname>Flags=
</varname>.
</para>
556 <para>Note that the three flags affect only automatic partition mounting, as implemented by
557 <citerefentry><refentrytitle>systemd-gpt-auto-generator
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
558 or the
<option>--image=
</option> option of various commands (such as
559 <citerefentry><refentrytitle>systemd-nspawn
</refentrytitle><manvolnum>1</manvolnum></citerefentry>). It
560 has no effect on explicit mounts, such as those done via
<citerefentry
561 project='man-pages'
><refentrytitle>mount
</refentrytitle><manvolnum>8</manvolnum></citerefentry> or
563 project='man-pages'
><refentrytitle>fstab
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
565 <para>If both bit
50 and
59 are set for a partition (i.e. the partition is marked both read-only and
566 marked for file system growing) the latter is typically without effect: the read-only flag takes
567 precedence in most tools reading these flags, and since growing the file system involves writing to
568 the partition it is consequently ignored.
</para>
570 <para><varname>NoAuto=
</varname> defaults to off.
<varname>ReadOnly=
</varname> defaults to on for
571 Verity partition types, and off for all others.
<varname>GrowFileSystem=
</varname> defaults to on for
572 all partition types that support it, except if the partition is marked read-only (and thus
573 effectively, defaults to off for Verity partitions).
</para></listitem>
577 <term><varname>SplitName=
</varname></term>
579 <listitem><para>Configures the suffix to append to split artifacts when the
<option>--split
</option>
580 option of
<command>systemd-repart
</command> is used. Simple specifier expansion is supported, see
581 below. Defaults to
<literal>%t
</literal>. To disable split artifact generation for a partition, set
582 <varname>SplitName=
</varname> to
<literal>-
</literal>.
</para></listitem>
586 <term><varname>Minimize=
</varname></term>
588 <listitem><para>Takes a boolean. Disabled by default. If enabled, the partition is created at least
589 as big as required for the minimal file system of the type specified by
<varname>Format=
</varname>,
590 taking into account the sources configured with
<varname>CopyFiles=
</varname>. Note that unless the
591 filesystem is a read-only filesystem,
<command>systemd-repart
</command> will have to populate the
592 filesystem twice, so enabling this option might slow down repart when populating large partitions.
599 <title>Specifiers
</title>
601 <para>Specifiers may be used in the
<varname>Label=
</varname>,
<varname>CopyBlocks=
</varname>,
602 <varname>CopyFiles=
</varname>,
<varname>MakeDirectories=
</varname>,
<varname>SplitName=
</varname>
603 settings. The following expansions are understood:
</para>
604 <table class='specifiers'
>
605 <title>Specifiers available
</title>
606 <tgroup cols='
3' align='left' colsep='
1' rowsep='
1'
>
607 <colspec colname=
"spec" />
608 <colspec colname=
"mean" />
609 <colspec colname=
"detail" />
612 <entry>Specifier
</entry>
613 <entry>Meaning
</entry>
614 <entry>Details
</entry>
618 <xi:include href=
"standard-specifiers.xml" xpointer=
"a"/>
619 <xi:include href=
"standard-specifiers.xml" xpointer=
"A"/>
620 <xi:include href=
"standard-specifiers.xml" xpointer=
"b"/>
621 <xi:include href=
"standard-specifiers.xml" xpointer=
"B"/>
622 <xi:include href=
"standard-specifiers.xml" xpointer=
"H"/>
623 <xi:include href=
"standard-specifiers.xml" xpointer=
"l"/>
624 <xi:include href=
"standard-specifiers.xml" xpointer=
"m"/>
625 <xi:include href=
"standard-specifiers.xml" xpointer=
"M"/>
626 <xi:include href=
"standard-specifiers.xml" xpointer=
"o"/>
627 <xi:include href=
"standard-specifiers.xml" xpointer=
"v"/>
628 <xi:include href=
"standard-specifiers.xml" xpointer=
"w"/>
629 <xi:include href=
"standard-specifiers.xml" xpointer=
"W"/>
630 <xi:include href=
"standard-specifiers.xml" xpointer=
"T"/>
631 <xi:include href=
"standard-specifiers.xml" xpointer=
"V"/>
632 <xi:include href=
"standard-specifiers.xml" xpointer=
"percent"/>
637 <para>Additionally, for the
<varname>SplitName=
</varname> setting, the following specifiers are also
639 <table class='specifiers'
>
640 <title>Specifiers available
</title>
641 <tgroup cols='
3' align='left' colsep='
1' rowsep='
1'
>
642 <colspec colname=
"spec" />
643 <colspec colname=
"mean" />
644 <colspec colname=
"detail" />
647 <entry>Specifier
</entry>
648 <entry>Meaning
</entry>
649 <entry>Details
</entry>
654 <entry><literal>%T
</literal></entry>
655 <entry>Partition Type UUID
</entry>
656 <entry>The partition type UUID, as configured with
<varname>Type=
</varname></entry>
659 <entry><literal>%t
</literal></entry>
660 <entry>Partition Type Identifier
</entry>
661 <entry>The partition type identifier corresponding to the partition type UUID
</entry>
664 <entry><literal>%U
</literal></entry>
665 <entry>Partition UUID
</entry>
666 <entry>The partition UUID, as configured with
<varname>UUID=
</varname></entry>
669 <entry><literal>%n
</literal></entry>
670 <entry>Partition Number
</entry>
671 <entry>The partition number assigned to the partition
</entry>
679 <title>Examples
</title>
682 <title>Grow the root partition to the full disk size at first boot
</title>
684 <para>With the following file the root partition is automatically grown to the full disk if possible during boot.
</para>
686 <para><programlisting># /usr/lib/repart.d/
50-root.conf
689 </programlisting></para>
693 <title>Create a swap and home partition automatically on boot, if missing
</title>
695 <para>The home partition gets all available disk space while the swap partition gets
1G at most and
64M
696 at least. We set a priority
> 0 on the swap partition to ensure the swap partition is not used if not
697 enough space is available. For every three bytes assigned to the home partition the swap partition gets
700 <para><programlisting># /usr/lib/repart.d/
60-home.conf
703 </programlisting></para>
705 <para><programlisting># /usr/lib/repart.d/
70-swap.conf
712 </programlisting></para>
716 <title>Create B partitions in an A/B Verity setup, if missing
</title>
718 <para>Let's say the vendor intends to update OS images in an A/B setup, i.e. with two root partitions
719 (and two matching Verity partitions) that shall be used alternatingly during upgrades. To minimize
720 image sizes the original image is shipped only with one root and one Verity partition (the
"A" set),
721 and the second root and Verity partitions (the
"B" set) shall be created on first boot on the free
722 space on the medium.
</para>
724 <para><programlisting># /usr/lib/repart.d/
50-root.conf
729 </programlisting></para>
731 <para><programlisting># /usr/lib/repart.d/
60-root-verity.conf
736 </programlisting></para>
738 <para>The definitions above cover the
"A" set of root partition (of a fixed
512M size) and Verity
739 partition for the root partition (of a fixed
64M size). Let's use symlinks to create the
"B" set of
740 partitions, since after all they shall have the same properties and sizes as the
"A" set.
</para>
742 <para><programlisting># ln -s
50-root.conf /usr/lib/repart.d/
70-root-b.conf
743 # ln -s
60-root-verity.conf /usr/lib/repart.d/
80-root-verity-b.conf
744 </programlisting></para>
748 <title>Create a data and verity partition from a OS tree
</title>
750 <para>Assuming we have an OS tree at /var/tmp/os-tree that we want to package in a root partition
751 together with a matching verity partition, we can do so as follows:
</para>
753 <para><programlisting>#
50-root.conf
756 CopyFiles=/var/tmp/os-tree
759 </programlisting></para>
761 <para><programlisting>#
60-root-verity.conf
766 </programlisting></para>
772 <title>See Also
</title>
774 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
775 <citerefentry><refentrytitle>systemd-repart
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
776 <citerefentry project='man-pages'
><refentrytitle>sfdisk
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
777 <citerefentry><refentrytitle>systemd-cryptenroll
</refentrytitle><manvolnum>1</manvolnum></citerefentry>