2009-07-28 00:39:48 +00:00
|
|
|
<html>
|
|
|
|
|
<body>
|
|
|
|
|
<h1>Secret XML format</h1>
|
|
|
|
|
|
|
|
|
|
<ul id="toc"></ul>
|
|
|
|
|
|
|
|
|
|
<h2><a name="SecretAttributes">Secret XML</a></h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Secrets stored by libvirt may have attributes associated with them, using
|
|
|
|
|
the <code>secret</code> element. The <code>secret</code> element has two
|
|
|
|
|
optional attributes, each with values '<code>yes</code>' and
|
|
|
|
|
'<code>no</code>', and defaulting to '<code>no</code>':
|
|
|
|
|
</p>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><code>ephemeral</code></dt>
|
|
|
|
|
<dd>This secret must only be kept in memory, never stored persistently.
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><code>private</code></dt>
|
|
|
|
|
<dd>The value of the secret must not be revealed to any caller of libvirt,
|
|
|
|
|
nor to any other node.
|
|
|
|
|
</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
<p>
|
|
|
|
|
The top-level <code>secret</code> element may contain the following
|
|
|
|
|
elements:
|
|
|
|
|
</p>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><code>uuid</code></dt>
|
|
|
|
|
<dd>
|
|
|
|
|
An unique identifier for this secret (not necessarily in the UUID
|
|
|
|
|
format). If omitted when defining a new secret, a random UUID is
|
|
|
|
|
generated.
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><code>description</code></dt>
|
|
|
|
|
<dd>A human-readable description of the purpose of the secret.
|
|
|
|
|
</dd>
|
2009-09-01 17:25:11 +00:00
|
|
|
<dt><code>usage</code></dt>
|
|
|
|
|
<dd>
|
2009-11-06 15:04:19 +00:00
|
|
|
Specifies what this secret is used for. A mandatory
|
|
|
|
|
<code>type</code> attribute specifies the usage category, currently
|
|
|
|
|
only <code>volume</code> is defined. Specific usage categories are
|
|
|
|
|
described below.
|
2009-09-01 17:25:11 +00:00
|
|
|
</dd>
|
2009-07-28 00:39:48 +00:00
|
|
|
</dl>
|
|
|
|
|
|
2009-09-01 17:25:11 +00:00
|
|
|
<h3>Usage type "volume"</h3>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
This secret is associated with a volume, and it is safe to delete the
|
|
|
|
|
secret after the volume is deleted. The <code><usage
|
|
|
|
|
type='volume'></code> element must contain a
|
|
|
|
|
single <code>volume</code> element that specifies the key of the volume
|
|
|
|
|
this secret is associated with.
|
|
|
|
|
</p>
|
|
|
|
|
|
2009-07-28 00:39:48 +00:00
|
|
|
<h2><a name="example">Example</a></h2>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<secret ephemeral='no' private='yes'>
|
|
|
|
|
<description>LUKS passphrase for the main hard drive of our mail server</description>
|
2009-09-01 17:25:11 +00:00
|
|
|
<usage type='volume'>
|
|
|
|
|
<volume>/var/lib/libvirt/images/mail.img</volume>
|
|
|
|
|
</usage>
|
2009-07-28 00:39:48 +00:00
|
|
|
</secret></pre>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
