[libvirt] [PATCHv2 5/5] hyperv: Add basic documentation

[Matthias Bolte]

2011/8/20 Eric Blake <eblake at redhat.com>:
> On 08/03/2011 09:00 AM, Matthias Bolte wrote:
>>
>> ---
>>
>> v2:
>> - move microsoft.com link to drvhyperv.html.in
>>
>>  docs/drivers.html.in   |    1 +
>>  docs/drvhyperv.html.in |  112
>> ++++++++++++++++++++++++++++++++++++++++++++++++
>>  docs/index.html.in     |    3 +
>>  docs/sitemap.html.in   |    4 ++
>>  src/README             |    3 +-
>
> Thanks!  Too often, the docs get overlooked.
>
>> +<h2><a name="uri">Connections to the Microsoft Hyper-V driver</a></h2>
>> +<p>
>> +        Some example remote connection URIs for the driver are:
>> +</p>
>> +<pre>
>> +hyperv://example-hyperv.com                  (over HTTPS)
>> +hyperv://example-hyperv.com/?transport=http  (over HTTP)
>
> Wouldn't it be more typical to represent that as:
>
>  hyperv+http://example-hyperv.com/
>
> that is, qemu+ssh://... uses ssh as the transport, rather than
> qemu://host/?transport=ssh

Well, this was modeled after the way the ESX driver does it. In
retrospect I'm not sure why I did it this way in the ESX driver.

The HTTP transport in the ESX driver is mainly for debugging by
tcpdump'ing the communication and the HTTP transport in the Hyper-V
driver is there because this was simpler than configuring my Hyper-V
server for HTTPS :)

>> +</pre>
>> +<p>
>> +<strong>Note</strong>: In contrast to other drivers, the Hyper-V driver
>> +        is a client-side-only driver. It connects to the Hyper-V server
>> using
>> +        WS-Management over HTTP(S). Therefore, the
>> +<a href="remote.html">remote transport mechanism</a>  provided by the
>> +        remote driver and libvirtd will not work, and you cannot use URIs
>> like
>> +<code>hyperv+ssh://example.com</code>.
>
> Then again, I guess I see why not.
>
>> +<p>
>> +        To allow<code>Basic</code>  authentication with HTTP transport
>> WinRM
>> +        needs to allow unencrypted communication. This can be enabled via
>> the
>> +        WinRM commandline tool. Although this is not the recommended
>> +        communication mode.
>
> s/Although/However,/
>
> ACK.

-- 
Matthias Bolte
http://photron.blogspot.com