diff --git a/docs/formatsecret.html b/docs/formatsecret.html index 929eb86e54..5fd62227b7 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. -
volume
Key of a volume this secret is associated with. It is safe to delete - the secret after the volume is deleted.
description
A human-readable description of the purpose of the secret. +
usage
+ Specifies what this secret is used for. A mandatory + type attribute specifies the usage category, currently + only volume is defined. Specific usage categories are + described below.
+

Usage type "volume"

+

+ This secret is associated with a volume, and it is safe to delete the + secret after the volume is deleted. The <usage + type='volume'> element must contain a + single volume element that specifies the key of the volume + this secret is associated with. +

Example

       <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>
diff --git a/docs/formatsecret.html.in b/docs/formatsecret.html.in index 7471bf7207..72022cb643 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. -
volume
-
Key of a volume this secret is associated with. It is safe to delete - the secret after the volume is deleted. -
description
A human-readable description of the purpose of the secret.
+
usage
+
+ Specifies what this secret is used for. A mandatory + type attribute specifies the usage category, currently + only volume is defined. Specific usage categories are + described below. +
+

Usage type "volume"

+ +

+ This secret is associated with a volume, and it is safe to delete the + secret after the volume is deleted. The <usage + type='volume'> element must contain a + single volume element that specifies the key of the volume + this secret is associated with. +

+

Example

       <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>
diff --git a/docs/schemas/secret.rng b/docs/schemas/secret.rng index 05e04f21c4..8cfbd8f00e 100644 --- a/docs/schemas/secret.rng +++ b/docs/schemas/secret.rng @@ -34,11 +34,23 @@ - + + + + + + + + volume + + + + +