Skip to content

Commit b26618a

Browse files
committed
docs: add hypervisor namespace field descriptions
1 parent 1c90dd2 commit b26618a

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

internal/codegen/docs/domain.yaml

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,105 @@ entries:
119119
- path: domain.cpu.max_phys_addr
120120
description: Configures a limit on the physical address width visible to the guest, thereby constraining the maximum guest physical address range.
121121
reference: https://libvirt.org/formatdomain.html#cpu-model-and-topology
122+
- path: domain.qemu_commandline
123+
description: Configures QEMU-specific command-line passthrough for a domain, allowing explicit extra arguments and environment variables to be passed through the dedicated QEMU XML namespace.
124+
reference: https://libvirt.org/kbase/qemu-passthrough-security.html#xml-document-additions
125+
- path: domain.qemu_commandline.args
126+
description: Lists additional QEMU command-line arguments to append in order; each item represents one argument token rather than a shell-joined string.
127+
reference: https://libvirt.org/kbase/qemu-passthrough-security.html#xml-document-additions
128+
- path: domain.qemu_commandline.args.value
129+
description: Sets one QEMU command-line argument token exactly as passed to the QEMU process; values that conceptually belong together must still be provided as separate entries.
130+
reference: https://libvirt.org/kbase/qemu-passthrough-security.html#xml-document-additions
131+
- path: domain.qemu_commandline.envs
132+
description: Lists environment variables to expose to the QEMU process when starting the domain.
133+
reference: https://libvirt.org/kbase/qemu-passthrough-security.html#xml-document-additions
134+
- path: domain.qemu_commandline.envs.name
135+
description: Sets the environment variable name passed to QEMU, such as `QEMU_AUDIO_DRV`.
136+
reference: https://libvirt.org/kbase/qemu-passthrough-security.html#xml-document-additions
137+
- path: domain.qemu_commandline.envs.value
138+
description: Sets the optional value for the named QEMU environment variable; if omitted, the variable is declared without an explicit value.
139+
reference: https://libvirt.org/kbase/qemu-passthrough-security.html#xml-document-additions
140+
- path: domain.qemu_capabilities
141+
description: Configures QEMU capability toggles through the QEMU namespace, allowing named capabilities to be explicitly added to or removed from the launched device model.
142+
- path: domain.qemu_capabilities.add
143+
description: Lists QEMU capabilities to add explicitly for this domain.
144+
- path: domain.qemu_capabilities.add.name
145+
description: Sets the QEMU capability name referenced by this entry, using the capability identifier expected by libvirt and the QEMU driver; whether it is added or removed depends on whether the entry is placed under `add` or `del`.
146+
- path: domain.qemu_capabilities.del
147+
description: Lists QEMU capabilities to remove explicitly for this domain.
148+
- path: domain.qemu_capabilities.del.name
149+
description: Sets the QEMU capability name referenced by this entry, using the capability identifier expected by libvirt and the QEMU driver; whether it is added or removed depends on whether the entry is placed under `add` or `del`.
150+
- path: domain.qemu_override
151+
description: Configures QEMU frontend property overrides in the QEMU namespace, targeting specific devices by alias and setting named frontend properties.
152+
- path: domain.qemu_override.devices
153+
description: Lists device-specific QEMU overrides, each matched by device alias and carrying frontend property overrides.
154+
- path: domain.qemu_override.devices.alias
155+
description: Sets the libvirt device alias identifying which frontend device the override applies to.
156+
- path: domain.qemu_override.devices.frontend
157+
description: Configures frontend property overrides for the selected QEMU device.
158+
- path: domain.qemu_override.devices.frontend.properties
159+
description: Lists individual QEMU frontend properties to override on the selected device.
160+
- path: domain.qemu_override.devices.frontend.properties.name
161+
description: Sets the QEMU frontend property name to override.
162+
- path: domain.qemu_override.devices.frontend.properties.type
163+
description: Sets the optional type hint for the overridden QEMU property value.
164+
- path: domain.qemu_override.devices.frontend.properties.value
165+
description: Sets the optional value assigned to the named QEMU frontend property.
166+
- path: domain.qemu_deprecation
167+
description: Configures the QEMU namespace deprecation behavior for the domain.
168+
- path: domain.qemu_deprecation.behavior
169+
description: Sets the deprecation handling mode requested from libvirt for QEMU-specific deprecated behavior.
170+
- path: domain.lxc_namespace
171+
description: Configures inherited Linux namespaces for LXC guests, allowing selected namespaces to be shared with another process or namespace provider.
172+
reference: https://libvirt.org/drvlxc.html
173+
- path: domain.lxc_namespace.share_net
174+
description: Configures sharing of the network namespace for the LXC guest instead of creating a private one.
175+
reference: https://libvirt.org/drvlxc.html
176+
- path: domain.lxc_namespace.share_net.type
177+
description: Sets how the shared namespace target is identified for this namespace mapping.
178+
- path: domain.lxc_namespace.share_net.value
179+
description: Sets the identifier of the shared namespace target, interpreted according to `type`.
180+
- path: domain.lxc_namespace.share_ipc
181+
description: Configures sharing of the IPC namespace for the LXC guest instead of creating a private one.
182+
reference: https://libvirt.org/drvlxc.html
183+
- path: domain.lxc_namespace.share_ipc.type
184+
description: Sets how the shared namespace target is identified for this namespace mapping.
185+
- path: domain.lxc_namespace.share_ipc.value
186+
description: Sets the identifier of the shared namespace target, interpreted according to `type`.
187+
- path: domain.lxc_namespace.share_uts
188+
description: Configures sharing of the UTS namespace for the LXC guest instead of creating a private one.
189+
reference: https://libvirt.org/drvlxc.html
190+
- path: domain.lxc_namespace.share_uts.type
191+
description: Sets how the shared namespace target is identified for this namespace mapping.
192+
- path: domain.lxc_namespace.share_uts.value
193+
description: Sets the identifier of the shared namespace target, interpreted according to `type`.
194+
- path: domain.bhyve_commandline
195+
description: Configures bhyve-specific command-line passthrough for a domain, allowing extra arguments and environment variables to be appended through the bhyve XML namespace.
196+
reference: https://libvirt.org/drvbhyve.html
197+
- path: domain.bhyve_commandline.args
198+
description: Lists additional bhyve command-line arguments to append in order when starting the domain.
199+
reference: https://libvirt.org/drvbhyve.html
200+
- path: domain.bhyve_commandline.args.value
201+
description: Sets one additional argument token passed to the bhyve process.
202+
reference: https://libvirt.org/drvbhyve.html
203+
- path: domain.bhyve_commandline.envs
204+
description: Lists environment variables to provide to the bhyve process when starting the domain.
205+
- path: domain.bhyve_commandline.envs.name
206+
description: Sets the environment variable name passed to the bhyve process.
207+
- path: domain.bhyve_commandline.envs.value
208+
description: Sets the optional value for the named bhyve environment variable.
209+
- path: domain.vmware_data_center_path
210+
description: Sets the VMware datacenter path associated with the domain when using the VMware driver, matching the datacenter-oriented path conventions used by libvirt `vpx://` connections.
211+
reference: https://libvirt.org/drvesx.html
212+
- path: domain.xen_commandline
213+
description: Configures Xen-specific command-line passthrough to the qemu device model, using the Xen XML namespace for additional arguments.
214+
reference: https://libvirt.org/drvxen.html
215+
- path: domain.xen_commandline.args
216+
description: Lists additional command-line arguments to pass to the Xen qemu device model in order.
217+
reference: https://libvirt.org/drvxen.html
218+
- path: domain.xen_commandline.args.value
219+
description: Sets one additional argument token passed to the Xen qemu device model.
220+
reference: https://libvirt.org/drvxen.html
122221
- path: domain.cpu.migratable
123222
description: Controls whether the configured CPU model is considered migratable between hosts, using "yes" or "no" string values.
124223
reference: https://libvirt.org/formatdomain.html#cpu-model-and-topology

0 commit comments

Comments
 (0)