README.markdown

   1 # OpenDaylight Ansible Role
   2
   3 Ansible role for the [OpenDaylight SDN controller](http://www.opendaylight.org/project/technical-overview).
   4
   5 **This project is new and under construction. See our [issue tracker](https://github.com/dfarrell07/ansible-opendaylight/issues) for detals.**
   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 ## Dependencies
  20
  21 The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
  22
  23 ## Example Playbook
  24
  25 The simple example playbook below would install and configure OpenDaylight using this role.
  26
  27 ```
  28 ---
  29 - hosts: example_host
  30   sudo: yes
  31   roles:
  32     - opendaylight
  33 ```
  34
  35 ## License
  36
  37 The OpenDaylight Ansible role is Open Sourced under a BSD two-clause license. Contributions encouraged!
  38
  39 ## Author Information
  40
  41 Daniel Farrell of the OpenDaylight Integration Team is the main developer of this module.
  42
  43 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.