From dbe11ba385e169e90a9b230b4b7007ae43bc82eb Mon Sep 17 00:00:00 2001
From: Claudiu Belu <cbelu@cloudbasesolutions.com>
Date: Wed, 1 Oct 2014 18:06:18 +0300
Subject: [PATCH] Adds documentation section for neutron-hyperv-agent

Added section regarding the Hyper-V neutron agent in
doc/admin-guide-cloud/networking/section_networking-agents.xml

Change-Id: I381b60ef8471ac91100a9f2acebea13c2b2deda6
---
 .../section_networking_config-agents.xml      | 36 +++++++++++++++++++
 doc/common/samples/neutron-hyperv-agent.conf  | 20 +++++++++++
 2 files changed, 56 insertions(+)
 create mode 100644 doc/common/samples/neutron-hyperv-agent.conf

diff --git a/doc/admin-guide-cloud/networking/section_networking_config-agents.xml b/doc/admin-guide-cloud/networking/section_networking_config-agents.xml
index ec8f546cfb..dcaad0574b 100644
--- a/doc/admin-guide-cloud/networking/section_networking_config-agents.xml
+++ b/doc/admin-guide-cloud/networking/section_networking_config-agents.xml
@@ -549,4 +549,40 @@ interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver</programlist
             </step>
         </procedure>
     </section>
+    <section xml:id="install_neutron-hyperv-agent">
+    <title>Configure Hyper-V L2 agent</title>
+    <para>Before you install the OpenStack Networking Hyper-V L2 agent on a
+            Hyper-V compute node, ensure the compute node has been configured
+            correctly using these <link
+                xlink:href="http://docs.openstack.org/trunk/config-reference/content/hyper-v-virtualization-platform.html"
+                >instructions</link>.</para>
+    <procedure>
+      <title>To install the OpenStack Networking Hyper-V agent and configure the node</title>
+      <step>
+        <para>Download the OpenStack Networking code from the repository:</para>
+        <screen><prompt>></prompt> <userinput>cd C:\OpenStack\</userinput>
+<prompt>></prompt> <userinput>git clone https://github.com/openstack/neutron.git</userinput></screen>
+      </step>
+      <step>
+        <para>Install the OpenStack Networking Hyper-V Agent:</para>
+        <screen><prompt>></prompt> cd C:\OpenStack\neutron\
+<prompt>></prompt> python setup.py install</screen>
+      </step>
+      <step>
+        <para>Copy the <filename>policy.json</filename> file:</para>
+        <screen><prompt>></prompt> <userinput>xcopy C:\OpenStack\neutron\etc\policy.json C:\etc\</userinput></screen>
+      </step>
+      <step>
+        <para>Create the <filename>C:\etc\neutron-hyperv-agent.conf</filename> file and add the
+        proper configuration options and the <link
+        xlink:href="http://docs.openstack.org/trunk/config-reference/content/networking-plugin-hyperv_agent.html">Hyper-V
+        related options</link>. Here is a sample config file:</para>
+        <programlisting><xi:include parse="text" href="../../common/samples/neutron-hyperv-agent.conf"/></programlisting>
+      </step>
+      <step>
+        <para>Start the OpenStack Networking Hyper-V agent:</para>
+        <screen><prompt>></prompt> <userinput>C:\Python27\Scripts\neutron-hyperv-agent.exe --config-file C:\etc\neutron-hyperv-agent.conf</userinput></screen>
+      </step>
+    </procedure>
+    </section>
 </section>
diff --git a/doc/common/samples/neutron-hyperv-agent.conf b/doc/common/samples/neutron-hyperv-agent.conf
new file mode 100644
index 0000000000..50d4170a60
--- /dev/null
+++ b/doc/common/samples/neutron-hyperv-agent.conf
@@ -0,0 +1,20 @@
+[DEFAULT]
+verbose = true
+control_exchange = neutron
+policy_file = C:\etc\policy.json
+rpc_backend = neutron.openstack.common.rpc.impl_kombu
+rabbit_host = IP_ADDRESS
+rabbit_port = 5672
+rabbit_userid = guest
+rabbit_password = <password>
+logdir = C:\OpenStack\Log
+logfile = neutron-hyperv-agent.log
+
+[AGENT]
+polling_interval = 2
+physical_network_vswitch_mappings = *:YOUR_BRIDGE_NAME
+enable_metrics_collection = true
+
+[SECURITYGROUP]
+firewall_driver = neutron.plugins.hyperv.agent.security_groups_driver.HyperVSecurityGroupsDriver
+enable_security_group = true