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
description
usage
type
attribute specifies the usage category, currently
+ only volume
is defined. Specific usage categories are
+ described below.
+ 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.
+
<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
description
usage
type
attribute specifies the usage category, currently
+ only volume
is defined. Specific usage categories are
+ described below.
+
+ 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.
+
<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>