Merge lp:~james-page/charms/trusty/odl-controller/doc-updates into lp:~openstack-charmers-archive/charms/trusty/odl-controller/next

[James Page]

[lp:~james-page/charms/trusty/odl-controller/doc-updates]

14. By James Page on 2015-11-18

Tweak

[Liam Young (gnuoy)]

LGTM

review: Approve

[uosci-testing-bot (uosci-testing-bot)]

charm_lint_check #13984 odl-controller-next for james-page mp277797
    LINT OK: passed

Build: http://10.245.162.77:8080/job/charm_lint_check/13984/

[uosci-testing-bot (uosci-testing-bot)]

charm_unit_test #13036 odl-controller-next for james-page mp277797
    UNIT OK: passed

Build: http://10.245.162.77:8080/job/charm_unit_test/13036/

[uosci-testing-bot (uosci-testing-bot)]

charm_amulet_test #7914 odl-controller-next for james-page mp277797
    AMULET FAIL: amulet-test failed

AMULET Results (max last 2 lines):
make: *** [functional_test] Error 1
ERROR:root:Make target returned non-zero.

Full amulet test output: http://paste.ubuntu.com/13328058/
Build: http://10.245.162.77:8080/job/charm_amulet_test/7914/

=== modified file 'README.md'
--- README.md	2015-02-19 22:08:13 +0000
+++ README.md	2015-11-18 09:45:49 +0000
@@ -1,16 +1,42 @@
-Overview
---------
+# Overview
 
-OpenDaylight (www.opendaylight.org) is a fully featured Software Defined
-Networking (SDN) solution for private clouds. It provides a Neutron plugin to
+OpenDaylight (www.opendaylight.org) is a fully featured Software Defined Networking (SDN) solution for private clouds. It provides a Neutron plugin to
 integrate with OpenStack.
 
-This charm is designed to be used in conjunction with the rest of the OpenStack
-related charms in the charm store to virtualize the network that Nova Compute
-instances plug into.
-
-This charm provides the controller component.
+This charm is designed to be used in conjunction with the rest of the OpenStack related charms in the charm store to virtualize the network that Nova Compute instances plug into.
+
+This charm provides the controller component of an OpenDayLight installation.
+
 Only OpenStack Icehouse or newer is supported.
 
-Usage
------
+# Usage
+
+To deploy the OpenDayLight controller:
+
+    juju deploy odl-controller
+
+To integrate OpenDayLight into an OpenStack Cloud (subset of commands):
+
+    juju deploy neutron-api-odl
+    juju deploy openvswitch-odl
+
+The neutron-gateway charm must also be deployed with 'ovs-odl' as the plugin configuration option:
+
+    cat > config.yaml << EOF
+    neutron-gateway:
+        plugin: ovs-odl
+    EOF
+    juju deploy --config config.yaml neutron-gateway
+
+And then add relations between services to complete the deployment:
+
+    juju add-relation neutron-api neutron-api-odl
+    juju add-relation neutron-api-odl odl-controller
+
+    juju add-relation openvswitch-odl nova-compute
+    juju add-relation openvswitch-odl neutron-gateway
+    juju add-relation openvswitch-odl odl-controller
+
+# Contact Information
+
+Report bugs on [Launchpad](http://bugs.launchpad.net/charms/+source/odl-controller/+filebug)
 
=== modified file 'metadata.yaml'
--- metadata.yaml	2015-11-11 14:57:38 +0000
+++ metadata.yaml	2015-11-18 09:45:49 +0000
@@ -1,6 +1,6 @@
 name: odl-controller
 summary: OpenDaylight Controller
-maintainer: Robert Ayres <[e-mail]>
+maintainer: OpenStack Charmers <[e-mail]>
 description: |
   OpenDaylight is a network virtualization solution that provides an overlay
   virtual-network to virtual-machines, containers or network namespaces.