shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-23 21:35:11 +03:00
Code
3e00171dcd
systemd/man/systemd-network-generator.service.xml

165 lines
7.0 KiB
XML
Raw Normal View History

man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<?xml version='1.0'?> <!--*-nxml-*-->
<!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: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
man: Add xinclude namespace This will be used by the next commit to add version information to the nodes.
2023-08-22 19:52:02 +03:00
<refentry id="systemd-network-generator.service" xmlns:xi="http://www.w3.org/2001/XInclude">
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<refentryinfo>
<title>systemd-network-generator.service</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-network-generator.service</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-network-generator.service</refname>
<refname>systemd-network-generator</refname>
<refpurpose>Generate network configuration from the kernel command line</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>systemd-network-generator.service</filename></para>
<para><filename>/usr/lib/systemd/systemd-network-generator</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><filename>systemd-network-generator.service</filename> is a system service that translates
man: document the new ip=link-local kernel cmdline option
2023-10-30 20:05:42 +03:00
<varname>ip=</varname> and related settings on the kernel command line (see below) into
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
configuration files understood by
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
<para>Files are generated in <filename>/run/systemd/network/</filename>.</para>
man: add note that network-generator is not a generator Also fix indentation.
2022-11-08 13:07:02 +03:00
<para>Note: despite the name, this generator executes as a normal systemd service and is
<emphasis>not</emphasis> an implementation of the
<citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>
concept.</para>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
</refsect1>
man: add note that network-generator is not a generator Also fix indentation.
2022-11-08 13:07:02 +03:00
<refsect1>
<title>Kernel command line options</title>
<para>This tool understands the following options:</para>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<variablelist class='kernel-commandline-options'>
<varlistentry>
<term><varname>ip=</varname></term>
man: document nameserver= option
2023-11-08 18:29:25 +03:00
<term><varname>nameserver=</varname></term>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<term><varname>rd.route=</varname></term>
<term><varname>rd.peerdns=</varname></term>
<listitem>
man: document the new ip=link-local kernel cmdline option
2023-10-30 20:05:42 +03:00
<para>Translated into
<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
files.</para>
<para>In addition to the parameters <citerefentry
project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>
defines the <varname>ip=</varname> option accepts the special value
<literal>link-local</literal>. If selected, the network interfaces will be configured for
link-local addressing (IPv4LL, IPv6LL) only, DHCP or IPv6RA will not be enabled.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ifname=</varname></term>
network-generator: support to set NamePolicy= through kernel command line argument Closes #16296.
2021-12-14 05:29:08 +03:00
<term><varname>net.ifname-policy=</varname></term>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<listitem>
man: document the new ip=link-local kernel cmdline option
2023-10-30 20:05:42 +03:00
<para>Translated into
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
files.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>vlan=</varname></term>
<term><varname>bond=</varname></term>
<term><varname>bridge=</varname></term>
<term><varname>bootdev=</varname></term>
<listitem>
man: document the new ip=link-local kernel cmdline option
2023-10-30 20:05:42 +03:00
<para>Translated into
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
files.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
</listitem>
</varlistentry>
<!-- unsupported:
team=<teammaster>:<teamslaves>
bootdev=
BOOTIF=
bootdev=
bootdev=
bootdev=
-->
</variablelist>
<para>See
man/network-generator: replace dracut.kernel reference with dracut.cmdline `dracut.kernel.7` is just a symlink to `dracut.cmdline.7`, so the web reference points to a non-existent URL (https://man7.org/linux/man-pages/man7/dracut.kernel.7.html).
2023-03-21 11:09:24 +03:00
<citerefentry project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>
network-generator: support to set NamePolicy= through kernel command line argument Closes #16296.
2021-12-14 05:29:08 +03:00
and
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
for option syntax and details.</para>
</refsect1>
network-generator: pick up .netdev/.link/.network configuration via credentials To me this is the last major basic functionality that couldn't be configured via credentials: the network. We do not invent any new format for this, but simply copy relevant creds 1:1 into /run/systemd/network/ to open up the full functionality of networkd to VM hosts.
2024-01-08 13:25:56 +03:00
<refsect1>
<title>Credentials</title>
<para><command>systemd-network-generator</command> supports the service credentials logic as implemented
by
<varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname>
(see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
details). The following credentials are used when passed in:</para>
<variablelist class='system-credentials'>
<varlistentry>
<term><varname>network.netdev.*</varname></term>
<term><varname>network.link.*</varname></term>
<term><varname>network.network.*</varname></term>
<listitem><para>These credentials should contain valid
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
configuration data. From each matching credential a separate file is created. Example: a passed
credential <filename>network.link.50-foobar</filename> will be copied into a configuration file
<filename>50-foobar.link</filename>.</para>
<para>Note that the resulting files are created world-readable, it's hence recommended to not include
secrets in these credentials, but supply them via separate credentials directly to
<filename>systemd-networkd.service</filename>.</para>
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
</variablelist>
<para>Note that by default the <filename>systemd-network-generator.service</filename> unit file is set up
to inherit the these credentials from the service manager.</para>
</refsect1>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
<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>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
</simplelist></para>
man: add systemd-network-generator.service(8) It's a bit bare-bones, but it should be enough to point the reader in the right direction.
2020-03-05 10:05:24 +03:00
</refsect1>
</refentry>
Copy Permalink