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

John Ferlan jferlan at redhat.com
Mon Aug 19 21:24:04 UTC 2013


On 08/16/2013 11:58 AM, Ján Tomko wrote:
> 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><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.
>> +      this secret is associated with. For example, create a demo-secret.xml
>> +      file as follows:
>>      </p>
>>  
>> -    <h3>Usage type "ceph"</h3>
>> +    <pre>
>> +      <secret ephemeral='no' private='yes'>
>> +         <description>LUKS passphrase for the main hard drive of our mail server</description>
> 
> I don't think qcow encryption supports LUKS or that using it for a mail server
> would be a good idea. How about:
> <description>super secret name of my first puppy</description>
> 
>> +         <uuid>0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f</uuid>
>> +         <usage type='volume'>
>> +            <volume>/var/lib/libvirt/images/mail.img</volume>
>> +         </usage>
>> +      </secret>
>> +    </pre>

Fair enough - I've changed it to:

+    <pre>
+      <secret ephemeral='no' private='yes'>
+         <description>Super secret name of my first puppy</description>
+         <uuid>0a81f5b2-8403-7b23-c8d6-21ccc2f80d6f</uuid>
+         <usage type='volume'>
+            <volume>/var/lib/libvirt/images/puppyname.img</volume>
+         </usage>
+      </secret>
+    </pre>


John




More information about the libvir-list mailing list