9:12 a.m.
* docs/formatsecret.html.in, docs/formatsecret.html: Document <usage
type='volume'>, replacing stand-alone <volume>.
* docs/schemas/secret.rng: Update schema to require <usage
type='volume'>
---
docs/formatsecret.html | 19 ++++++++++++++++---
docs/formatsecret.html.in | 25 ++++++++++++++++++++-----
docs/schemas/secret.rng | 14 +++++++++++++-
3 files changed, 49 insertions(+), 9 deletions(-)
diff --git a/docs/formatsecret.html b/docs/formatsecret.html
index 929eb86..5fd6222 100644
--- a/docs/formatsecret.html
+++ b/docs/formatsecret.html
@@ -152,17 +152,30 @@
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>volume</code></dt><dd>Key of a
volume this secret is associated with. It is safe to delete
- the secret after the volume is deleted.
</dd><dt><code>description</code></dt><dd>A
human-readable description of the purpose of the secret.
+ </dd><dt><code>usage</code></dt><dd>
+ 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.
</dd></dl>
+ <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>
<h2>
<a name="example" id="example">Example</a>
</h2>
<pre>
<secret ephemeral='no' private='yes'>
- <volume>/var/lib/libvirt/images/mail.img</volume>
<description>LUKS passphrase for the main hard drive of our mail
server</description>
+ <usage type='volume'>
+
<volume>/var/lib/libvirt/images/mail.img</volume>
+ </usage>
</secret></pre>
</div>
</div>
diff --git a/docs/formatsecret.html.in b/docs/formatsecret.html.in
index 7471bf7..72022cb 100644
--- a/docs/formatsecret.html.in
+++ b/docs/formatsecret.html.in
@@ -32,21 +32,36 @@
format). If omitted when defining a new secret, a random UUID is
generated.
</dd>
- <dt><code>volume</code></dt>
- <dd>Key of a volume this secret is associated with. It is safe to delete
- the secret after the volume is deleted.
- </dd>
<dt><code>description</code></dt>
<dd>A human-readable description of the purpose of the secret.
</dd>
+ <dt><code>usage</code></dt>
+ <dd>
+ 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.
+ </dd>
</dl>
+ <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>
+
<h2><a name="example">Example</a></h2>
<pre>
<secret ephemeral='no' private='yes'>
- <volume>/var/lib/libvirt/images/mail.img</volume>
<description>LUKS passphrase for the main hard drive of our mail
server</description>
+ <usage type='volume'>
+
<volume>/var/lib/libvirt/images/mail.img</volume>
+ </usage>
</secret></pre>
</body>
</html>
diff --git a/docs/schemas/secret.rng b/docs/schemas/secret.rng
index 05e04f2..8cfbd8f 100644
--- a/docs/schemas/secret.rng
+++ b/docs/schemas/secret.rng
@@ -34,11 +34,23 @@
</element>
</optional>
<optional>
- <element name='volume'>
+ <element name='usage'>
+ <choice>
+ <ref name='usagevolume'>
+ </choice>
<text/>
</element>
</optional>
</interleave>
</element>
</define>
+
+ <define name='usagevolume'>
+ <attribute name='type'>
+ <value>volume</value>
+ </attribute>
+ <element name='volume'>
+ <text/>
+ </element>
+ </define>
</grammar>
--
1.6.2.5