diff --git a/README.md b/README.md index 34eaadd..8f81c01 100644 --- a/README.md +++ b/README.md @@ -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 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. -This charm provides the controller component. 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 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) diff --git a/metadata.yaml b/metadata.yaml index ffabdd3..57ed62e 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -1,6 +1,6 @@ name: odl-controller summary: OpenDaylight Controller -maintainer: Robert Ayres +maintainer: OpenStack Charmers description: | OpenDaylight is a network virtualization solution that provides an overlay virtual-network to virtual-machines, containers or network namespaces.