README.markdown

   1 [![Build Status](https://travis-ci.org/dfarrell07/dfarrell07-opendaylight.svg)](https://travis-ci.org/dfarrell07/dfarrell07-opendaylight)
   2
   3 #### Table of Contents
   4
   5 1. [Overview](#overview)
   6 2. [Module Description - What the module does and why it is useful](#module-description)
   7 3. [Setup - The basics of getting started with opendaylight](#setup)
   8     * [What opendaylight affects](#what-opendaylight-affects)
   9     * [Setup requirements](#setup-requirements)
  10     * [Beginning with opendaylight](#beginning-with-opendaylight)
  11 4. [Usage - Configuration options and additional functionality](#usage)
  12 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  13 5. [Limitations - OS compatibility, etc.](#limitations)
  14 6. [Development - Guide for contributing to the module](#development)
  15
  16 ## Overview
  17
  18 Puppet module for deploying the OpenDaylight Software Defined Networking (SDN) controller.
  19
  20 ## Module Description
  21
  22 Stands up the OpenDaylight SDN controller from an RPM, including systemd configuration.
  23
  24 ## Setup
  25
  26 ### What opendaylight affects
  27
  28 * Installs OpenDaylight archive in /opt/
  29 * Installs a systemd unit file for OpenDaylight
  30 * Creates an `odl` group if it doesn't exist
  31
  32 ### Beginning with opendaylight
  33
  34 TODO: Update
  35
  36 ```
  37 The very basic steps needed for a user to get the module up and running.
  38
  39 If your most recent release breaks compatibility or requires particular steps for upgrading, you may wish to include an additional section here: Upgrading (For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).
  40 ```
  41
  42 ## Usage
  43
  44 TODO: Update
  45
  46 ```
  47 Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.
  48 ```
  49
  50 ## Reference
  51
  52 TODO: Update
  53
  54 ```
  55 Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)
  56 ```
  57
  58 ## Limitations
  59
  60 * The target OS must use systemd (Fedora 15+, CentOS 7+).
  61 * Currently only supports RPM-based installs.
  62
  63 ## Development
  64
  65 See [CONTRIBUTING.md](https://github.com/dfarrell07/puppet-opendaylight/blob/master/CONTRIBUTING.md) for details about how to contribute to this OpenDaylight Puppet module.
  66
  67 ## Release Notes/Contributors
  68
  69 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.