README.markdown

   1 # OpenDaylight Ansible Role
   2
   3 Ansible role for the [OpenDaylight SDN controller][1].
   4
   5 **This project is new and under construction. See our [issue tracker](https://github.com/dfarrell07/ansible-opendaylight/issues) for details.**
   6
   7 ## Requirements
   8
   9 The OpenDaylight Ansible role handles the installation and configuration of all of its dependences.
  10
  11 ## Role Variables
  12
  13 ### Karaf Features
  14
  15 To set extra Karaf features to be installed at OpenDaylight start time, pass them in a list to the `extra_features` param. The extra features you pass will typically be driven by the requirements of your ODL install. You'll almost certainly need to pass some.
  16
  17 OpenDaylight normally installs a default set of Karaf features at boot. They are recommended, so the ODL Puppet mod defaults to installing them. This can be customized by overriding the `default_features` param. You shouldn't normally need to do so.
  18
  19 ### REST API Port
  20
  21 To change the port on which OpenDaylight's northbound listens for REST API calls, use the `odl_rest_port` param. This was added because OpenStack's Swift project uses a conflicting port.
  22
  23 ## Dependencies
  24
  25 The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
  26
  27 ## Example Playbook
  28
  29 The simple example playbook below would install and configure OpenDaylight using this role.
  30
  31 ```yaml
  32 ---
  33 - hosts: example_host
  34   sudo: yes
  35   roles:
  36     - opendaylight
  37 ```
  38
  39 ## License
  40
  41 The OpenDaylight Ansible role is Open Sourced under a BSD two-clause license. Contributions encouraged!
  42
  43 ## Author Information
  44
  45 [Daniel Farrell][2] of the [OpenDaylight Integration Team][3] is the main developer of this role.
  46
  47 Please raise [issues](https://github.com/dfarrell07/ansible-opendaylight/issues) to ask questions, request features, report bugs or otherwise contribute. Please avoid 1-1 communication, as Open Source projects benefit from public, documented communication.
  48
  49
  50 [1]: http://www.opendaylight.org/project/technical-overview
  51 [2]: https://twitter.com/dfarrell07
  52 [3]: https://wiki.opendaylight.org/view/CrossProject:Integration_Group