Re: [libvirt] [PATCH 5/6] docs: Update formatsecrets to include more examples of each type

On 08/08/2013 02:43 AM, John Ferlan wrote: > Update formatsecret docs to describe the various options and provide examples > in order to set up secrets for each type of secret. > --- > docs/formatsecret.html.in | 156 ++++++++++++++++++++++++++++++++++++++++++---- > 1 file changed, 145 insertions(+), 11 deletions(-) ACK > > diff --git a/docs/formatsecret.html.in b/docs/formatsecret.html.in > index 3e306b5..7dd0927 100644 > --- a/docs/formatsecret.html.in > +++ b/docs/formatsecret.html.in > @@ -46,18 +46,51 @@ > </dd> > </dl> > > - <h3>Usage type "volume"</h3> > + <h3><a name="VolumeUsageType">Usage type "volume"</a></h3> > > <p> > This secret is associated with a volume, and it is safe to delete the > secret after the volume is deleted. The <code>&lt;usage > type='volume'&gt;</code> element must contain a > single <code>volume</code> element that specifies the key of the volume > - this secret is associated with. > + this secret is associated with. For example, create a demo-secret.xml > + file as follows: > </p> > > - <h3>Usage type "ceph"</h3> > + <pre> > + &lt;secret ephemeral='no' private='yes'&gt; > + &lt;description&gt;LUKS passphrase for the main hard drive of our mail server&lt;/description&gt; I don't think qcow encryption supports LUKS or that using it for a mail server would be a good idea. How about: &lt;description&gt;super secret name of my first puppy&lt;/description&gt; > + &lt;uuid&gt;0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f&lt;/uuid&gt; > + &lt;usage type='volume'&gt; > + &lt;volume&gt;/var/lib/libvirt/images/mail.img&lt;/volume&gt; > + &lt;/usage&gt; > + &lt;/secret&gt; > + </pre>