README.markdown

   1 [![CI Status][7]][6]
   2
   3 # OpenDaylight Ansible Role
   4
   5 Ansible role for the [OpenDaylight SDN controller][1].
   6
   7 Releases of this role can also be installed available via [Ansible Galaxy][5].
   8
   9 ## Requirements
  10
  11 The OpenDaylight Ansible role handles the installation and configuration of
  12 all of its dependences.
  13
  14 ## Role Variables
  15
  16 ### Karaf Features
  17
  18 To set extra Karaf features to be installed at OpenDaylight start time,
  19 pass them in a list to the `extra_features` variable. The extra features
  20 you pass will typically be driven by the requirements of your ODL install.
  21 You'll almost certainly need to pass some.
  22
  23 OpenDaylight normally installs a default set of Karaf features at boot.
  24 They are recommended, so the ODL Ansible role defaults to installing them.
  25 This can be customized by overriding the `default_features` variable. You
  26 shouldn't normally need to do so.
  27
  28 ### REST API Port
  29
  30 To change the port on which OpenDaylight's northbound listens for REST API
  31 calls, use the `odl_rest_port` variable. This was added because OpenStack's
  32 Swift project uses a conflicting port.
  33
  34 The Ansible role will handle opening this port in FirewallD if it's active.
  35
  36 ## Dependencies
  37
  38 The OpenDaylight Ansible role doesn't depend on any other Ansible roles.
  39
  40 ## Example Playbook
  41
  42 The simple example playbook below would install and configure OpenDaylight
  43 using this role.
  44
  45 ```yaml
  46 ---
  47 - hosts: example_host
  48   sudo: yes
  49   roles:
  50     - opendaylight
  51 ```
  52
  53 To override default settings, pass variables to the `opendaylight` role.
  54
  55 ```yaml
  56 ---
  57 - hosts: all
  58   sudo: yes
  59   roles:
  60     - role: opendaylight
  61       extra_features: ['odl-ovsdb-openstack']
  62 ```
  63
  64 Results in:
  65
  66     opendaylight-user@root>feature:list | grep odl-ovsdb-openstack
  67     odl-ovsdb-openstack | 1.1.0-Lithium | x | ovsdb-1.1.0-Lithium <snip>
  68
  69 ## License
  70
  71 The OpenDaylight Ansible role is Open Sourced under a BSD two-clause license.
  72
  73 [Contributions encouraged][4]!
  74
  75 ## Author Information
  76
  77 [Daniel Farrell][2] of the [OpenDaylight Integration Team][3] is the main
  78 developer of this role.
  79
  80 See [CONTRIBUTING.md][4] for details about how to contribute to the
  81 OpenDaylight Ansible role.
  82
  83
  84 [1]: http://www.opendaylight.org/project/technical-overview
  85 [2]: https://twitter.com/dfarrell07
  86 [3]: https://wiki.opendaylight.org/view/CrossProject:Integration_Group
  87 [4]: https://github.com/dfarrell07/ansible-opendaylight/blob/master/CONTRIBUTING.md
  88 [5]: https://galaxy.ansible.com/list#/roles/3948
  89 [6]: https://travis-ci.org/dfarrell07/ansible-opendaylight
  90 [7]: https://travis-ci.org/dfarrell07/ansible-opendaylight.svg