shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-22 17:35:35 +03:00
Code
41a9a502a1
systemd/man/systemd-machined.service.xml

142 lines
7.9 KiB
XML
Raw Normal View History

man: document machinectl and systemd-machined
2013-07-07 06:22:05 +04:00
<?xml version='1.0'?> <!--*-nxml-*-->
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 07:23:58 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document machinectl and systemd-machined
2013-07-07 06:22:05 +04:00
<refentry id="systemd-machined.service" conditional='ENABLE_MACHINED'>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<refentryinfo>
<title>systemd-machined.service</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-machined.service</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-machined.service</refname>
<refname>systemd-machined</refname>
<refpurpose>Virtual machine and container registration manager</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>systemd-machined.service</filename></para>
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-18 20:47:44 +03:00
<para><filename>/usr/lib/systemd/systemd-machined</filename></para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsynopsisdiv>
<refsect1>
<title>Description</title>
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
<para><command>systemd-machined</command> is a system service that keeps track of locally running virtual
machines and containers.</para>
<para><command>systemd-machined</command> is useful for registering and keeping track of both OS
containers (containers that share the host kernel but run a full init system of their own and behave in
most regards like a full virtual operating system rather than just one virtualized app) and full virtual
machines (virtualized hardware running normal operating systems and possibly different kernels).</para>
<para><command>systemd-machined</command> should <emphasis>not</emphasis> be used for registering/keeping
track of application sandbox containers. A <emphasis>machine</emphasis> in the context of
<command>systemd-machined</command> is supposed to be an abstract term covering both OS containers and
full virtual machines, but not application sandboxes.</para>
<para>Machines registered with machined are exposed in various ways in the system. For example:
<itemizedlist>
<listitem><para>Tools like
<citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
will show to which machine a specific process belongs in a column of
its own, and so will
<ulink url="https://help.gnome.org/users/gnome-system-monitor/">gnome-system-monitor</ulink> or
<citerefentry><refentrytitle>systemd-cgls</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
</listitem>
<listitem><para>systemd's various tools
(<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, ...)
support the <option>-M</option> switch to operate on local containers instead of the host system.
</para></listitem>
<listitem><para><command>systemctl list-machines</command> will show the system state of all local
containers, connecting to the container's init system for that.</para></listitem>
<listitem><para>systemctl's <option>--recursive</option> switch has the effect of not only showing the
man: fixes from online review Also includes the issues pointed out by @boucman.
2020-04-14 14:43:11 +03:00
locally running services, but recursively showing the services of all registered containers.</para></listitem>
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
<listitem><para>The <command>machinectl</command> command provides access to a number of useful
operations on registered containers, such as introspecting them, rebooting, shutting them down, and
getting a login prompt on them.</para></listitem>
<listitem><para>The
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> library
exposes the
man: fix various internal references Found with linkchecker.
2020-06-25 15:38:21 +03:00
<citerefentry><refentrytitle>sd_bus_open_system_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
call to connect to the system bus of any registered container.</para></listitem>
<listitem><para>The
<citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry>
module makes sure all registered containers can be resolved via normal glibc
<citerefentry project='man-pages'><refentrytitle>gethostbyname</refentrytitle><manvolnum>3</manvolnum></citerefentry>
or
<citerefentry project='man-pages'><refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum></citerefentry>
calls.</para></listitem>
</itemizedlist></para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
<para>See
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>
for some examples on how to run containers with OS tools.</para>
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
<para>If you are interested in writing a VM or container manager that makes use of machined, please have
various: update links to more wiki pages
2024-05-28 15:37:23 +03:00
look at <ulink url="https://systemd.io/WRITING_VM_AND_CONTAINER_MANAGERS">Writing
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
Virtual Machine or Container Managers</ulink>. Also see the <ulink
man: update links to "New Control Group Interfaces"
2024-05-28 13:42:18 +03:00
url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
Interfaces</ulink>.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
<para>The daemon provides both a C library interface
(which is shared with <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
machined: add varlink interface for registering machines This commit adds the new varlink interface io.systemd.Machine at /run/systemd/machine/io.systemd.Machine with a single method Register It supports all combinations of RegisterMachine[WithSSH,WithNetwork] all under the same method.
2024-04-23 12:26:59 +03:00
as well as a D-Bus interface and a Varlink interface.
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
The library interface may be used to introspect and watch the state of virtual machines/containers.
The bus interface provides the same but in addition may also be used to register or terminate
machined: add varlink interface for registering machines This commit adds the new varlink interface io.systemd.Machine at /run/systemd/machine/io.systemd.Machine with a single method Register It supports all combinations of RegisterMachine[WithSSH,WithNetwork] all under the same method.
2024-04-23 12:26:59 +03:00
machines. The Varlink interface may be used to register machines with optional extensions, e.g. with an
SSH key / address; it can be queried with
<command>varlinkctl introspect /run/systemd/machine/io.systemd.Machine io.systemd.Machine</command>.
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
For more information please consult
<citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>
and
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03:00
<citerefentry><refentrytitle>org.freedesktop.machine1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: add description of org.freedesktop.LogControl1 I'm not sure if the LogTarget property is sufficiently general to be made into a property that can be generally implemented. It is very closely tied to the internal systemd logic. The other two seem fine thoough.
2020-04-24 22:04:43 +03:00
and
man: assorted small fixes This is almost all of #17177.
2020-09-29 13:31:27 +03:00
<citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
man: import org.freedesktop.machine1(3) from the wiki The wiki was primarily describing the D-Bus API, but it also had a large introduction to the daemon functionality. I moved that latter part into the page that describes the daemon, and the API description into the new page. This is mostly a straighforward import. Apart from some required formatting changes, I removed obvious repetitions, and made tiny grammar and typo fixes where I noticed them. The goal is not to have a perfect text immediately. <interfacename>org.foo.bar</interface> is used for interface names, <function>function()</function> for methods, and <function>signal</function> (no parentheses) for signal names. In D-Bus, signals are similar to methods, and docbook doesn't have a nice tag for them.
2020-04-07 22:22:13 +03:00
</para>
<para>A small companion daemon
<citerefentry><refentrytitle>systemd-importd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
is also available, which implements importing, exporting, and downloading of container and VM images.
</para>
man: document new varlink service
2020-07-07 22:29:21 +03:00
<para>For each container registered with <filename>systemd-machined.service</filename> that employs user
namespacing, users/groups are synthesized for the used UIDs/GIDs. These are made available to the system
using the <ulink url="https://systemd.io/USER_GROUP_API">User/Group Record Lookup API via
Varlink</ulink>, and thus may be resolved with
<citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> or the
usual glibc NSS calls.</para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-22 21:09:32 +03:00
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
</simplelist></para>
Reindent man pages to 2ch
2015-02-04 05:14:13 +03:00
</refsect1>
man: document machinectl and systemd-machined
2013-07-07 06:22:05 +04:00
</refentry>
Copy Permalink