]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/portablectl.xml
man: use same version in public and system ident.
[thirdparty/systemd.git] / man / portablectl.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
5
6 <refentry id="portablectl" conditional='ENABLE_PORTABLED'
7 xmlns:xi="http://www.w3.org/2001/XInclude">
8
9 <refentryinfo>
10 <title>portablectl</title>
11 <productname>systemd</productname>
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>portablectl</refentrytitle>
16 <manvolnum>1</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>portablectl</refname>
21 <refpurpose>Attach, detach or inspect portable service images</refpurpose>
22 </refnamediv>
23
24 <refsynopsisdiv>
25 <cmdsynopsis>
26 <command>portablectl</command>
27 <arg choice="opt" rep="repeat">OPTIONS</arg>
28 <arg choice="req">COMMAND</arg>
29 <arg choice="opt" rep="repeat">NAME</arg>
30 </cmdsynopsis>
31 </refsynopsisdiv>
32
33 <refsect1>
34 <title>Description</title>
35
36 <para><command>portablectl</command> may be used to attach, detach or inspect portable service images. It's
37 primarily a command interfacing with
38 <citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
39
40 <para>Portable service images contain an OS file system tree along with
41 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> unit file
42 information. A service image may be "attached" to the local system. If attached, a set of unit files are copied
43 from the image to the host, and extended with <varname>RootDirectory=</varname> or <varname>RootImage=</varname>
44 assignments (in case of service units) pointing to the image file or directory, ensuring the services will run
45 within the file system context of the image.</para>
46
47 <para>Portable service images are an efficient way to bundle multiple related services and other units together,
48 and transfer them as a whole between systems. When these images are attached the local system the contained units
49 may run in most ways like regular system-provided units, either with full privileges or inside strict sandboxing,
50 depending on the selected configuration. For more details, see
51 <ulink url="https://systemd.io/PORTABLE_SERVICES">Portable Services Documentation</ulink>.</para>
52
53 <para>Specifically portable service images may be of the following kind:</para>
54
55 <itemizedlist>
56 <listitem><para>Directory trees containing an OS, including the top-level directories <filename>/usr/</filename>,
57 <filename>/etc/</filename>, and so on.</para></listitem>
58
59 <listitem><para>btrfs subvolumes containing OS trees, similar to normal directory trees.</para></listitem>
60
61 <listitem><para>Binary "raw" disk images containing MBR or GPT partition tables and Linux file system
62 partitions. (These must be regular files, with the <filename>.raw</filename> suffix.)</para></listitem>
63 </itemizedlist>
64
65 </refsect1>
66
67 <refsect1>
68 <title>Commands</title>
69
70 <para>The following commands are understood:</para>
71
72 <variablelist>
73
74 <varlistentry>
75 <term><command>list</command></term>
76
77 <listitem><para>List available portable service images. This will list all portable service images discovered
78 in the portable image search paths (see below), along with brief metadata and state information. Note that many
79 of the commands below may both operate on images inside and outside of the search paths. This command is hence
80 mostly a convenience option, the commands are generally not restricted to what this list
81 shows.</para>
82
83 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
84 </varlistentry>
85
86 <varlistentry>
87 <term><command>attach</command> <replaceable>IMAGE</replaceable> [<replaceable>PREFIX…</replaceable>]</term>
88
89 <listitem><para>Attach a portable service image to the host system. Expects a file system path to a portable
90 service image file or directory as first argument. If the specified path contains no slash character
91 (<literal>/</literal>) it is understood as image filename that is searched for in the portable service image
92 search paths (see below). To reference a file in the current working directory prefix the filename with
93 <literal>./</literal> to avoid this search path logic.</para>
94
95 <para>When a portable service is attached four operations are executed:</para>
96
97 <orderedlist>
98
99 <listitem><para>All unit files of types <filename>.service</filename>, <filename>.socket</filename>,
100 <filename>.target</filename>, <filename>.timer</filename> and <filename>.path</filename> which match the
101 indicated unit file name prefix are copied from the image to the host's
102 <filename>/etc/systemd/system.attached/</filename> directory (or
103 <filename>/run/systemd/system.attached/</filename> — depending whether <option>--runtime</option> is
104 specified, see below), which is included in the built-in unit search path of the system service
105 manager.</para></listitem>
106
107 <listitem><para>For unit files of type <filename>.service</filename> a drop-in is added to these copies that
108 adds <varname>RootDirectory=</varname> or <varname>RootImage=</varname> settings (see
109 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
110 details), that ensures these services are run within the file system of the originating portable service
111 image.</para></listitem>
112
113 <listitem><para>A second drop-in is created: the "profile" drop-in, that may contain additional security
114 settings (and other settings). A number of profiles are available by default but administrators may define
115 their own ones. See below.</para></listitem>
116
117 <listitem><para>If the portable service image file is not already in the search path (see below), a symbolic
118 link to it is created in <filename>/etc/portables/</filename> or
119 <filename>/run/portables/</filename>, to make sure it is included in it.</para></listitem>
120 </orderedlist>
121
122 <para>By default all unit files whose names start with a prefix generated from the image's file name are copied
123 out. Specifically, the prefix is determined from the image file name with any suffix such as
124 <filename>.raw</filename> removed, truncated at the first occurrence of an underscore character
125 (<literal>_</literal>), if there is one. The underscore logic is supposed to be used to versioning so that the
126 an image file <filename>foobar_47.11.raw</filename> will result in a unit file matching prefix of
127 <filename>foobar</filename>. This prefix is then compared with all unit files names contained in the image in
128 the usual directories, but only unit file names where the prefix is followed by <literal>-</literal>,
129 <literal>.</literal> or <literal>@</literal> are considered. Example: if a portable service image file is named
130 <filename>foobar_47.11.raw</filename> then by default all its unit files with names such as
131 <filename>foobar-quux-waldi.service</filename>, <filename>foobar.service</filename> or
132 <filename>foobar@.service</filename> will be considered. It's possible to override the matching prefix: all
133 strings listed on the command line after the image file name are considered prefixes, overriding the implicit
134 logic where the prefix is derived from the image file name.</para>
135
136 <para>By default, after the unit files are attached the service manager's configuration is reloaded, except
137 when <option>--no-reload</option> is specified (see below). This ensures that the new units made available to
138 the service manager are seen by it.</para>
139
140 <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are
141 immediately started (blocking operation unless <option>--no-block</option> is passed) and/or enabled after
142 attaching the image.</para>
143
144 <xi:include href="version-info.xml" xpointer="v239"/>
145 </listitem>
146 </varlistentry>
147
148 <varlistentry>
149 <term><command>detach</command> <replaceable>IMAGE</replaceable> [<replaceable>PREFIX…</replaceable>]</term>
150
151 <listitem><para>Detaches a portable service image from the host. This undoes the operations executed by the
152 <command>attach</command> command above, and removes the unit file copies, drop-ins and image symlink
153 again. This command expects an image name or path as parameter. Note that if a path is specified only the last
154 component of it (i.e. the file or directory name itself, not the path to it) is used for finding matching unit
155 files. This is a convenience feature to allow all arguments passed as <command>attach</command> also to
156 <command>detach</command>.</para>
157
158 <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are
159 immediately stopped (blocking operation) and/or disabled before detaching the image. Prefix(es) are also accepted,
160 to be used in case the unit names do not match the image name as described in the <command>attach</command>.</para>
161
162 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
163 </varlistentry>
164
165 <varlistentry>
166 <term><command>reattach</command> <replaceable>IMAGE</replaceable> [<replaceable>PREFIX…</replaceable>]</term>
167
168 <listitem><para>Detaches an existing portable service image from the host, and immediately attaches it again.
169 This is useful in case the image was replaced. Running units are not stopped during the process. Partial matching,
170 to allow for different versions in the image name, is allowed: only the part before the first <literal>_</literal>
171 character has to match. If the new image doesn't exist, the existing one will not be detached. The parameters
172 follow the same syntax as the <command>attach</command> command.</para>
173
174 <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are
175 immediately stopped if removed, started and/or enabled if added, or restarted if updated. Prefixes are also
176 accepted, in the same way as described in the <command>attach</command> case.</para>
177
178 <xi:include href="version-info.xml" xpointer="v248"/></listitem>
179 </varlistentry>
180
181 <varlistentry>
182 <term><command>inspect</command> <replaceable>IMAGE</replaceable> [<replaceable>PREFIX…</replaceable>]</term>
183
184 <listitem><para>Extracts various metadata from a portable service image and presents it to the
185 caller. Specifically, the
186 <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> file of the
187 image is retrieved as well as all matching unit files. By default a short summary showing the most relevant
188 metadata in combination with a list of matching unit files is shown (that is the unit files
189 <command>attach</command> would install to the host system). If combined with <option>--cat</option> (see
190 above), the <filename>os-release</filename> data and the units files' contents is displayed unprocessed. This
191 command is useful to determine whether an image qualifies as portable service image, and which unit files are
192 included. This command expects the path to the image as parameter, optionally followed by a list of unit file
193 prefixes to consider, similar to the <command>attach</command> command described above.</para>
194
195 <xi:include href="version-info.xml" xpointer="v239"/>
196 </listitem>
197 </varlistentry>
198
199 <varlistentry>
200 <term><command>is-attached</command> <replaceable>IMAGE</replaceable></term>
201
202 <listitem><para>Determines whether the specified image is currently attached or not. Unless combined with the
203 <option>--quiet</option> switch this will show a short state identifier for the image. Specifically:</para>
204
205 <table>
206 <title>Image attachment states</title>
207 <tgroup cols='2'>
208 <colspec colname='state'/>
209 <colspec colname='description'/>
210 <thead>
211 <row>
212 <entry>State</entry>
213 <entry>Description</entry>
214 </row>
215 </thead>
216 <tbody>
217 <row>
218 <entry><option>detached</option></entry>
219 <entry>The image is currently not attached.</entry>
220 </row>
221 <row>
222 <entry><option>attached</option></entry>
223 <entry>The image is currently attached, i.e. its unit files have been made available to the host system.</entry>
224 </row>
225 <row>
226 <entry><option>attached-runtime</option></entry>
227 <entry>Like <option>attached</option>, but the unit files have been made available transiently only, i.e. the <command>attach</command> command has been invoked with the <option>--runtime</option> option.</entry>
228 </row>
229 <row>
230 <entry><option>enabled</option></entry>
231 <entry>The image is currently attached, and at least one unit file associated with it has been enabled.</entry>
232 </row>
233 <row>
234 <entry><option>enabled-runtime</option></entry>
235 <entry>Like <option>enabled</option>, but the unit files have been made available transiently only, i.e. the <command>attach</command> command has been invoked with the <option>--runtime</option> option.</entry>
236 </row>
237 <row>
238 <entry><option>running</option></entry>
239 <entry>The image is currently attached, and at least one unit file associated with it is running.</entry>
240 </row>
241 <row>
242 <entry><option>running-runtime</option></entry>
243 <entry>The image is currently attached transiently, and at least one unit file associated with it is running.</entry>
244 </row>
245 </tbody>
246 </tgroup>
247 </table>
248
249 <xi:include href="version-info.xml" xpointer="v239"/>
250
251 </listitem>
252 </varlistentry>
253
254 <varlistentry>
255 <term><command>read-only</command> <replaceable>IMAGE</replaceable> [<replaceable>BOOL</replaceable>]</term>
256
257 <listitem><para>Marks or (unmarks) a portable service image read-only. Takes an image name, followed by a
258 boolean as arguments. If the boolean is omitted, positive is implied, i.e. the image is marked
259 read-only.</para>
260
261 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
262 </varlistentry>
263
264 <varlistentry>
265 <term><command>remove</command> <replaceable>IMAGE</replaceable></term>
266
267 <listitem><para>Removes one or more portable service images. Note that this command will only remove the
268 specified image path itself — it refers to a symbolic link then the symbolic link is removed and not the
269 image it points to.</para>
270
271 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
272 </varlistentry>
273
274 <varlistentry>
275 <term><command>set-limit</command> [<replaceable>IMAGE</replaceable>] <replaceable>BYTES</replaceable></term>
276
277 <listitem><para>Sets the maximum size in bytes that a specific portable service image, or all images, may grow
278 up to on disk (disk quota). Takes either one or two parameters. The first, optional parameter refers to a
279 portable service image name. If specified, the size limit of the specified image is changed. If omitted, the
280 overall size limit of the sum of all images stored locally is changed. The final argument specifies the size
281 limit in bytes, possibly suffixed by the usual K, M, G, T units. If the size limit shall be disabled, specify
282 <literal>-</literal> as size.</para>
283
284 <para>Note that per-image size limits are only supported on btrfs file systems. Also, depending on
285 <varname>BindPaths=</varname> settings in the portable service's unit files directories from the host might be
286 visible in the image environment during runtime which are not affected by this setting, as only the image
287 itself is counted against this limit.</para>
288
289 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
290 </varlistentry>
291
292 </variablelist>
293
294 </refsect1>
295
296 <refsect1>
297 <title>Options</title>
298
299 <para>The following options are understood:</para>
300
301 <variablelist>
302 <varlistentry>
303 <term><option>-q</option></term>
304 <term><option>--quiet</option></term>
305
306 <listitem><para>Suppresses additional informational output while running.</para>
307
308 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
309 </varlistentry>
310
311 <varlistentry>
312 <term><option>-p</option> <replaceable>PROFILE</replaceable></term>
313 <term><option>--profile=</option><replaceable>PROFILE</replaceable></term>
314
315 <listitem><para>When attaching an image, select the profile to use. By default the <literal>default</literal>
316 profile is used. For details about profiles, see below.</para>
317
318 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
319 </varlistentry>
320
321 <varlistentry>
322 <term><option>--copy=</option></term>
323
324 <listitem><para>When attaching an image, select whether to prefer copying or symlinking of files installed into
325 the host system. Takes one of <literal>copy</literal> (to prefer copying of files), <literal>symlink</literal>
326 (to prefer creation of symbolic links) or <literal>auto</literal> for an intermediary mode where security
327 profile drop-ins are symlinked while unit files are copied. Note that this option expresses a preference only,
328 in cases where symbolic links cannot be created — for example when the image operated on is a raw disk image,
329 and hence not directly referentiable from the host file system — copying of files is used
330 unconditionally.</para>
331
332 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
333 </varlistentry>
334
335 <varlistentry>
336 <term><option>--runtime</option></term>
337
338 <listitem><para>When specified the unit and drop-in files are placed in
339 <filename>/run/systemd/system.attached/</filename> instead of
340 <filename>/etc/systemd/system.attached/</filename>. Images attached with this option set hence remain attached
341 only until the next reboot, while they are normally attached persistently.</para>
342
343 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
344 </varlistentry>
345
346 <varlistentry>
347 <term><option>--no-reload</option></term>
348
349 <listitem><para>Don't reload the service manager after attaching or detaching a portable service
350 image. Normally the service manager is reloaded to ensure it is aware of added or removed unit
351 files.</para>
352
353 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
354 </varlistentry>
355
356 <varlistentry>
357 <term><option>--cat</option></term>
358
359 <listitem><para>When inspecting portable service images, show the (unprocessed) contents of the metadata files
360 pulled from the image, instead of brief summaries. Specifically, this will show the
361 <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> and unit file
362 contents of the image.</para>
363
364 <xi:include href="version-info.xml" xpointer="v239"/></listitem>
365 </varlistentry>
366
367 <varlistentry>
368 <term><option>--enable</option></term>
369
370 <listitem><para>Immediately enable/disable the portable service after attaching/detaching.</para>
371
372 <xi:include href="version-info.xml" xpointer="v245"/></listitem>
373 </varlistentry>
374
375 <varlistentry>
376 <term><option>--now</option></term>
377
378 <listitem><para>Immediately start/stop/restart the portable service after attaching/before
379 detaching/after upgrading.</para>
380
381 <xi:include href="version-info.xml" xpointer="v245"/></listitem>
382 </varlistentry>
383
384 <varlistentry>
385 <term><option>--no-block</option></term>
386
387 <listitem><para>Don't block waiting for attach --now to complete.</para>
388
389 <xi:include href="version-info.xml" xpointer="v245"/></listitem>
390 </varlistentry>
391
392 <varlistentry>
393 <term><option>--extension=</option><replaceable>PATH</replaceable></term>
394
395 <listitem><para>Add an additional image <replaceable>PATH</replaceable> as an overlay on
396 top of <replaceable>IMAGE</replaceable> when attaching/detaching. This argument can be specified
397 multiple times, in which case the order in which images are laid down follows the rules specified in
398 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
399 for the <varname>ExtensionImages=</varname> directive and for the
400 <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry> and.
401 <citerefentry><refentrytitle>systemd-confext</refentrytitle><manvolnum>8</manvolnum></citerefentry> tools.
402 The images must contain an <filename>extension-release</filename> file with metadata that matches
403 what is defined in the <filename>os-release</filename> of <replaceable>IMAGE</replaceable>. See:
404 <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
405 Images can be block images, btrfs subvolumes or directories. For more information on portable
406 services with extensions, see the <literal>Extension Images</literal> paragraph on
407 <ulink url="https://systemd.io/PORTABLE_SERVICES">Portable Services Documentation</ulink>.
408 </para>
409
410 <para>Note that the same extensions have to be specified, in the same order, when attaching
411 and detaching.</para>
412
413 <xi:include href="version-info.xml" xpointer="v249"/></listitem>
414 </varlistentry>
415
416 <varlistentry>
417 <term><option>--force</option></term>
418
419 <listitem><para>Skip safety checks and attach or detach images (with extensions) without first ensuring
420 that the units are not running, and do not insist that the
421 <filename>extension-release.<replaceable>NAME</replaceable></filename> file in the extension image has
422 to match the image filename.</para>
423
424 <xi:include href="version-info.xml" xpointer="v252"/></listitem>
425 </varlistentry>
426
427 <xi:include href="user-system-options.xml" xpointer="host" />
428 <xi:include href="user-system-options.xml" xpointer="machine" />
429
430 <xi:include href="standard-options.xml" xpointer="no-pager" />
431 <xi:include href="standard-options.xml" xpointer="no-legend" />
432 <xi:include href="standard-options.xml" xpointer="no-ask-password" />
433 <xi:include href="standard-options.xml" xpointer="help" />
434 <xi:include href="standard-options.xml" xpointer="version" />
435 </variablelist>
436 </refsect1>
437
438 <refsect1>
439 <title>Files and Directories</title>
440
441 <para>Portable service images are preferably stored in <filename>/var/lib/portables/</filename>, but are also
442 searched for in <filename>/etc/portables/</filename>, <filename>/run/systemd/portables/</filename>,
443 <filename>/usr/local/lib/portables/</filename> and <filename>/usr/lib/portables/</filename>. It's recommended not
444 to place image files directly in <filename>/etc/portables/</filename> or
445 <filename>/run/systemd/portables/</filename> (as these are generally not suitable for storing large or non-textual
446 data), but use these directories only for linking images located elsewhere into the image search path.</para>
447
448 <para>When a portable service image is attached, matching unit files are copied onto the host into the
449 <filename>/etc/systemd/system.attached/</filename> and <filename>/run/systemd/system.attached/</filename>
450 directories. When an image is detached, the unit files are removed again from these directories.</para>
451 </refsect1>
452
453 <refsect1>
454 <title>Profiles</title>
455
456 <para>When portable service images are attached a "profile" drop-in is linked in, which may be used to enforce
457 additional security (and other) restrictions locally. Four profile drop-ins are defined by default, and shipped in
458 <filename>/usr/lib/systemd/portable/profile/</filename>. Additional, local profiles may be defined by placing them
459 in <filename>/etc/systemd/portable/profile/</filename>. The default profiles are:</para>
460
461 <table>
462 <title>Profiles</title>
463 <tgroup cols='2'>
464 <colspec colname='state'/>
465 <colspec colname='description'/>
466 <thead>
467 <row>
468 <entry>Name</entry>
469 <entry>Description</entry>
470 </row>
471 </thead>
472 <tbody>
473 <row>
474 <entry><filename>default</filename></entry>
475 <entry>This is the default profile if no other profile name is set via the <option>--profile=</option> (see above). It's fairly restrictive, but should be useful for common, unprivileged system workloads. This includes write access to the logging framework, as well as IPC access to the D-Bus system.</entry>
476 </row>
477 <row>
478 <entry><filename>nonetwork</filename></entry>
479 <entry>Very similar to <filename>default</filename>, but networking is turned off for any services of the portable service image.</entry>
480 </row>
481 <row>
482 <entry><filename>strict</filename></entry>
483 <entry>A profile with very strict settings. This profile excludes IPC (D-Bus) and network access.</entry>
484 </row>
485 <row>
486 <entry><filename>trusted</filename></entry>
487 <entry>A profile with very relaxed settings. In this profile the services run with full privileges.</entry>
488 </row>
489 </tbody>
490 </tgroup>
491 </table>
492
493 <para>For details on these profiles and their effects see their precise definitions,
494 e.g. <filename>/usr/lib/systemd/portable/profile/default/service.conf</filename> and similar.</para>
495 </refsect1>
496
497 <refsect1>
498 <title>Exit status</title>
499
500 <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
501 </refsect1>
502
503 <xi:include href="common-variables.xml" />
504
505 <refsect1>
506 <title>See Also</title>
507 <para><simplelist type="inline">
508 <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
509 <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
510 <member><citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
511 <member><citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
512 </simplelist></para>
513 </refsect1>
514
515 </refentry>