README.markdown

   1 [![Build Status](https://travis-ci.org/dfarrell07/puppet-opendaylight.svg)](https://travis-ci.org/dfarrell07/puppet-opendaylight) [![Dependency Status](https://gemnasium.com/dfarrell07/puppet-opendaylight.svg)](https://gemnasium.com/dfarrell07/puppet-opendaylight) [![Join the chat at https://gitter.im/dfarrell07/puppet-opendaylight](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dfarrell07/puppet-opendaylight?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
   2 #### Table of Contents
   3 1. [Overview](#overview)
   4 2. [Module Description - What the module does and why it is useful](#module-description)
   5 3. [Setup - The basics of getting started with opendaylight](#setup)
   6     * [What opendaylight affects](#what-opendaylight-affects)
   7     * [Setup requirements](#setup-requirements)
   8     * [Beginning with opendaylight](#beginning-with-opendaylight)
   9 4. [Usage - Configuration options and additional functionality](#usage)
  10 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  11 5. [Limitations - OS compatibility, etc.](#limitations)
  12 6. [Development - Guide for contributing to the module](#development)
  13
  14 ## Overview
  15
  16 Puppet module for deploying the [OpenDaylight Software Defined Networking (SDN) controller](http://www.opendaylight.org/).
  17
  18 ## Module Description
  19
  20 Deploys and configrues the [OpenDaylight SDN controller](http://www.opendaylight.org/), including systemd configuration.
  21
  22 Both supported install methods default to the lastest stable OpenDaylight release, which is currently Helium 0.2.2 SR2.
  23
  24 ## Setup
  25
  26 ### What `opendaylight` affects
  27
  28 * Installs [OpenDaylight](http://www.opendaylight.org/).
  29 * Installs a [systemd unitfile](https://github.com/dfarrell07/opendaylight-systemd/) for OpenDaylight.
  30 * Starts the `opendaylight` systemd service.
  31 * Creates `odl:odl` user:group if they don't already exist.
  32 * Installs Java, which is required by ODL.
  33
  34 ### Beginning with `opendaylight`
  35
  36 To install and start OpenDaylight, include the `opendaylight` class: `include opendaylight`.
  37
  38 ## Usage
  39
  40 The most basic usage, passing no parameters to the OpenDaylight class, will install and start OepnDaylight with a default configuration.
  41
  42 ```
  43 class { 'opendaylight':
  44 }
  45 ```
  46
  47 ### Karaf Features
  48
  49 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.
  50
  51 ```
  52 class { 'opendaylight':
  53   extra_features => ['odl-ovsdb-plugin', 'odl-ovsdb-openstack'],
  54 }
  55 ```
  56
  57 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.
  58
  59 ```
  60 class { 'opendaylight':
  61   default_features => ['config', 'standard', 'region', 'package', 'kar', 'ssh', 'management'],
  62 }
  63 ```
  64
  65 ### Install Method
  66
  67 The `install_method` param, and the associated `tarball_url` and `unitfile_url` params, are intended for use by developers who need to install a custom-built version of OpenDaylight, or for automated build processes that need to consume a tarball build artifact.
  68
  69 It's recommended that most people use the default RPM-based install.
  70
  71 If you do need to install from a tarball, simply pass `tarball` as the value for `install_method` and optionally pass the URL to your tarball via the `tarball_url` param. The default value for `tarball_url` points at OpenDaylight's latest release. The `unitfile_url` param points at the OpenDaylight systemd .service file used by the RPM and should (very likely) not need to be overridden.
  72
  73 ```
  74 class { 'opendaylight':
  75   install_method => 'tarball',
  76   tarball_url => '<URL to your custom tarball>',
  77   unitfile_url => '<URL to your custom unitfile>',
  78 }
  79 ```
  80
  81 ### Ports
  82
  83 To change the port OpenDaylight's northbound listens on for REST API calls, use the `odl_rest_port` param. This was added because OpenStack's Swift project uses a conflicting port.
  84
  85
  86 ```
  87 class { 'opendaylight':
  88   odl_rest_port => '8080',
  89 }
  90 ```
  91
  92 ## Reference
  93
  94 ### Classes
  95
  96 #### Public classes
  97
  98 * `opendaylight`: Main entry point to the module. All ODL knobs should be managed through its params.
  99
 100 #### Private classes
 101
 102 * `opendaylight::params`: Contains default `opendaylight` class param values.
 103 * `opendaylight::config`: Manages ODL config, including Karaf features and REST port.
 104 * `opendaylight::install`: Installs ODL from an RPM or tarball.
 105 * `opendaylight::service`: Starts the OpenDaylight service.
 106
 107 ## Limitations
 108
 109 * The target OS must use systemd (Fedora 15+, CentOS 7+).
 110 * Only tested on Fedora 20, 21 and CentOS 7.
 111 * CentOS 7 is currently the most stable OS option.
 112
 113 ## Development
 114
 115 See [CONTRIBUTING.md](https://github.com/dfarrell07/puppet-opendaylight/blob/master/CONTRIBUTING.md) for details about how to contribute to this OpenDaylight Puppet module.
 116
 117 ## Release Notes/Contributors
 118
 119 See the [CHANGELOG](https://github.com/dfarrell07/puppet-opendaylight/blob/master/CHANGELOG) for information about releases and [CONTRIBUTORS](https://github.com/dfarrell07/puppet-opendaylight/blob/master/CONTRIBUTORS) file for a list of folks who have contributed.