docs: rudimentary phyp documentation

Based on a report that phyp is undocumented: https://www.redhat.com/archives/libvirt-users/2012-July/msg00013.html * docs/drvphyp.html.in (phyp): New file. * docs/drivers.html.in: List it.
warewolf · Oct 3, 2012 · b893e76 · b893e76
1 parent 3b2cab7
commit b893e76
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/docs/drivers.html.in b/docs/drivers.html.in
@@ -29,6 +29,7 @@
       <li><strong><a href="drvvmware.html">VMware Workstation/Player</a></strong></li>
       <li><strong><a href="drvxen.html">Xen</a></strong></li>
       <li><strong><a href="drvhyperv.html">Microsoft Hyper-V</a></strong></li>
+      <li><strong><a href="drvphyp.html">IBM PowerVM (phyp)</a></strong></li>
     </ul>
 
     <h2><a name="storage">Storage drivers</a></h2>

diff --git a/docs/drvphyp.html.in b/docs/drvphyp.html.in
@@ -0,0 +1,48 @@
+<html><body>
+    <h1>IBM PowerVM hypervisor driver (phyp)</h1>
+    <ul id="toc"></ul>
+    <p>
+        The IBM PowerVM driver can manage both HMC and IVM PowerVM
+        guests.  VIOS connections are tunneled through HMC.
+    </p>
+
+
+    <h2><a name="project">Project Links</a></h2>
+    <ul>
+      <li>
+        The <a href="http://www-03.ibm.com/systems/power/software/virtualization/index.html">IBM
+        PowerVM</a> hypervisor
+      </li>
+    </ul>
+
+
+    <h2><a name="uri">Connections to the PowerVM driver</a></h2>
+    <p>
+        Some example remote connection URIs for the driver are:
+    </p>
+<pre>
+phyp://user@hmc/system (HMC connection)
+phyp://user@ivm/system (IVM connection)
+</pre>
+    <p>
+        <strong>Note</strong>: In contrast to other drivers, the
+        PowerVM (or phyp) driver is a client-side-only driver,
+        internally using ssh to connect to the specified hmc or ivm
+        server. 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>phyp+ssh://example.com</code>.
+    </p>
+
+
+    <h3><a name="uriformat">URI Format</a></h3>
+    <p>
+        URIs have this general form (<code>[...]</code> marks an
+        optional part, <code>{...|...}</code> marks a mandatory choice).
+    </p>
+<pre>
+phyp://[username@]{hmc|ivm}/managed_system
+</pre>
+    </p>
+
+</body></html>