# OpenDaylight
-#### Table of Contents
+#### Table of Contents
+
1. [Overview](#overview)
-1. [Module Description](#module-description)
-1. [Setup](#setup)
- * [What `opendaylight` affects](#what-opendaylight-affects)
- * [Beginning with `opendaylight`](#beginning-with-opendaylight)
-1. [Usage](#usage)
- * [Karaf Features](#karaf-features)
- * [Install Method](#install-method)
- * [RPM Repo](#rpm-repo)
- * [Ports](#ports)
- * [Log Verbosity](#log-verbosity)
- * [Enabling ODL OVSDB L3](#enabling-odl-ovsdb-l3)
- * [Enabling ODL OVSDB HA](#enabling-odl-ovsdb-ha)
-1. [Reference ](#reference)
-1. [Limitations](#limitations)
-1. [Development](#development)
-1. [Release Notes/Contributors](#release-notescontributors)
+2. [Module Description](#module-description)
+3. [Setup](#setup)
+ - [What `opendaylight` affects](#what-opendaylight-affects)
+ - [Beginning with `opendaylight`](#beginning-with-opendaylight)
+4. [Usage](#usage)
+ - [Karaf Features](#karaf-features)
+ - [Install Method](#install-method)
+ - [RPM Repo](#rpm-repo)
+ - [Ports](#ports)
+ - [Log Verbosity](#log-verbosity)
+ - [Enabling ODL OVSDB L3](#enabling-odl-ovsdb-l3)
+ - [Enabling ODL OVSDB HA](#enabling-odl-ovsdb-ha)
+5. [Reference ](#reference)
+6. [Limitations](#limitations)
+7. [Development](#development)
+8. [Release Notes/Contributors](#release-notescontributors)
## Overview
### What `opendaylight` affects
-* Installs Java, which is required by ODL.
-* Creates `odl:odl` user:group if they don't already exist.
-* Installs [OpenDaylight][7].
-* Installs a [systemd unitfile][9] or [Upstart config file][10] for
-OpenDaylight.
-* Manipulates OpenDaylight's configuration files according to the params
-passed to the `::opendaylight` class.
-* Starts the `opendaylight` systemd or Upstart service.
+- Installs Java, which is required by ODL.
+- Creates `odl:odl` user:group if they don't already exist.
+- Installs [OpenDaylight][7].
+- Installs a [systemd unitfile][9] or [Upstart config file][10] for
+ OpenDaylight.
+- Manipulates OpenDaylight's configuration files according to the params
+ passed to the `::opendaylight` class.
+- Starts the `opendaylight` systemd or Upstart service.
### Beginning with `opendaylight`
To change the port on which OpenDaylight's northbound listens for REST API
calls, use the `odl_rest_port` param.
-
```puppet
class { 'opendaylight':
odl_rest_port => '8080',
#### Public classes
-* `::opendaylight`: Main entry point to the module. All ODL knobs should be
-managed through its params.
+- `::opendaylight`: Main entry point to the module. All ODL knobs should be
+ managed through its params.
#### Private classes
-* `::opendaylight::params`: Contains default `opendaylight` class param values.
-* `::opendaylight::install`: Installs ODL from an RPM or tarball.
-* `::opendaylight::config`: Manages ODL config, including Karaf features and
-REST port.
-* `::opendaylight::service`: Starts the OpenDaylight service.
+- `::opendaylight::params`: Contains default `opendaylight` class param values.
+- `::opendaylight::install`: Installs ODL from an RPM or tarball.
+- `::opendaylight::config`: Manages ODL config, including Karaf features and
+ REST port.
+- `::opendaylight::service`: Starts the OpenDaylight service.
### `::opendaylight`
Valid options: A list of Karaf feature names as strings.
-##### `install_method `
+##### `install_method`
Specifies the install method by which to install OpenDaylight.
Valid options: The strings `'tarball'` or `'rpm'`.
-##### `odl_rest_port `
+##### `odl_rest_port`
Specifies the port for the ODL northbound REST interface to listen on.
Specifies the IPs that are part of the HA cluster enabled by `enable_ha`.
-Default: []
+Default: \[]
Valid options: An array of IP addresses `['10.10.10.1', '10.10.10.1', '10.10.10.3']`.
Required by: `enable_ha`, `ha_node_ips`
-
##### `tarball_url`
Specifies the ODL tarball to use when installing via the tarball install
## Limitations
-* Tested on Fedora 22, 23, CentOS 7 and Ubuntu 14.04.
-* CentOS 7 is currently the most stable OS option.
-* The RPM install method is likely more reliable than the tarball install
-method.
+- Tested on Fedora 22, 23, CentOS 7 and Ubuntu 14.04.
+- CentOS 7 is currently the most stable OS option.
+- The RPM install method is likely more reliable than the tarball install
+ method.
## Development
See the [CHANGELOG][15] or our [git tags][16] for information about releases.
See our [git commit history][17] for contributor information.
-
[1]: https://travis-ci.org/dfarrell07/puppet-opendaylight
+
[2]: https://gemnasium.com/dfarrell07/puppet-opendaylight
+
[4]: https://travis-ci.org/dfarrell07/puppet-opendaylight.svg
+
[5]: https://gemnasium.com/dfarrell07/puppet-opendaylight.svg
+
[7]: http://www.opendaylight.org/
+
[8]: https://github.com/dfarrell07/puppet-opendaylight/blob/master/CONTRIBUTING.markdown#issues
+
[9]: https://github.com/dfarrell07/opendaylight-systemd/
+
[10]: https://github.com/dfarrell07/puppet-opendaylight/blob/master/files/upstart.odl.conf
+
[11]: https://github.com/dfarrell07/vagrant-opendaylight/
+
[12]: https://github.com/dfarrell07/vagrant-opendaylight/tree/master/manifests
+
[13]: https://github.com/dfarrell07/puppet-opendaylight/issues/63
+
[14]: https://github.com/dfarrell07/puppet-opendaylight/blob/master/CONTRIBUTING.markdown
+
[15]: https://github.com/dfarrell07/puppet-opendaylight/blob/master/CHANGELOG
+
[16]: https://github.com/dfarrell07/puppet-opendaylight/releases
+
[17]: https://github.com/dfarrell07/puppet-opendaylight/commits/master
-[18]: http://cbs.centos.org/repos/nfv7-opendaylight-40-release/x86_64/os/Packages/ OpenDaylight Beryllium CentOS CBS repo
-[19]: https://wiki.opendaylight.org/view/Deployment#RPM OpenDaylight RPMs and their repos
+
+[18]: <http://cbs.centos.org/repos/nfv7-opendaylight-40-release/x86_64/os/Packages/> OpenDaylight Beryllium CentOS CBS repo
+[19]: <https://wiki.opendaylight.org/view/Deployment#RPM> OpenDaylight RPMs and their repos
Code Review / integration / packaging / puppet-opendaylight.git / blobdiff