Debian Codegraph @

upstream/debian-unstable/man8/systemd-imds-generator.8

raw
1 '\" t
2 .TH "SYSTEMD\-IMDS\-GENERATOR" "8" "" "systemd 261~rc3" "systemd-imds-generator"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-imds-generator \- Generator to automatically enable IMDS on supporting environments
24 .SH "SYNOPSIS"
25 .PP
26 /usr/lib/systemd/system\-generators/systemd\-imds\-generator
27 .SH "DESCRIPTION"
28 .PP
29 \fBsystemd\-imds\-generator\fR
30 is a generator that enables IMDS (Instance Metadata Service) functionality at boot on systems that support it\&. Specifically it does three things:
31 .sp
32 .RS 4
33 .ie n \{\
34 \h'-04'\(bu\h'+03'\c
35 .\}
36 .el \{\
37 .sp -1
38 .IP \(bu 2.3
39 .\}
40 It pulls the
41 systemd\-imdsd\&.socket
42 unit (which activates
43 \[email protected]\fR(8)) into the initial transaction, which provides IMDS access to local applications via Varlink IPC\&.
44 .RE
45 .sp
46 .RS 4
47 .ie n \{\
48 \h'-04'\(bu\h'+03'\c
49 .\}
50 .el \{\
51 .sp -1
52 .IP \(bu 2.3
53 .\}
54 It pulls the
55 systemd\-imds\-early\-network\&.service
56 unit into the initial transaction, which generates a suitable
57 \fBsystemd.network\fR(5)
58 network configuration file that allows early\-boot network access to the IMDS functionality\&.
59 .RE
60 .sp
61 .RS 4
62 .ie n \{\
63 \h'-04'\(bu\h'+03'\c
64 .\}
65 .el \{\
66 .sp -1
67 .IP \(bu 2.3
68 .\}
69 It pulls the
70 systemd\-imds\-import\&.service
71 unit into the initial transaction, which automatically imports various credentials from IMDS into the local system, storing them in
72 /run/credstore/\&.
73 .RE
74 .PP
75 By default, whether to pull in these services or not is decided based on
76 \fBhwdb\fR(7)
77 information, that detects various IMDS environments automatically\&. However, this logic may be overridden via
78 \fIsystemd\&.imds=\fR, see below\&.
79 .PP
80 \fBsystemd\-imds\-generator\fR
81 implements
82 \fBsystemd.generator\fR(7)\&.
83 .SH "KERNEL COMMAND LINE"
84 .PP
85 \fBsystemd\-imds\-generator\fR
86 understands the following kernel command line parameters:
87 .PP
88 \fIsystemd\&.imds=\fR
89 .RS 4
90 Takes a boolean argument or the special value
91 "auto", and may be used to enable or disable the IMDS logic\&. Note that this controls only whether the relevant services (as listed above) are automatically pulled into the initial transaction, it has no effect if some other unit or the user explicitly activates the relevant units\&. If this option is not used (or set to
92 "auto") automatic detection of IMDS is used, see above\&.
93 .sp
94 Added in version 261\&.
95 .RE
96 .PP
97 \fIsystemd\&.imds\&.network=\fR
98 .RS 4
99 Takes one of
100 "off",
101 "locked",
102 "unlocked"\&. Controls whether and how to set up networking for IMDS endpoint access\&. Unless set to
103 "off"
104 early boot networking is enabled, ensuring that the IMDS endpoint can be reached\&. If set to
105 "locked"
106 (the default) direct access to the IMDS endpoint by regular unprivileged processes is disabled via a "prohibit" route, so that any access must be done through
107 systemd\-imdsd@\&.service
108 or its associated tools\&. If set to
109 "unlocked"
110 this "prohibit" route is not created, and regular unprivileged processes can directly contact IMDS\&.
111 .sp
112 Added in version 261\&.
113 .RE
114 .PP
115 \fIsystemd\&.imds\&.import=\fR
116 .RS 4
117 Takes a boolean argument\&. If false the
118 systemd\-imds\-import\&.service
119 (see above) is not pulled into the initial transaction, i\&.e\&. no credentials are imported from IMDS\&. Defaults to true\&.
120 .sp
121 Added in version 261\&.
122 .RE
123 .SH "SEE ALSO"
124 .PP
125 \fBsystemd\fR(1), \fBsystemd-imds\fR(1), \[email protected]\fR(8), \fBsystemd.system-credentials\fR(7)