[![CI Status][4]][1]
[![Dependency Status][5]][2]
-[![Project Chatroom][6]][3]
# 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)
- * [Ports](#ports)
-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)
+- [RPM Repo](#rpm-repo)
+- [Deb Repo](#deb-repo)
+- [Ports](#ports)
+- [Log Verbosity](#log-verbosity)
+- [Enabling ODL HA](#enabling-odl-ha)
+
+5. [Reference ](#reference)
+6. [Limitations](#limitations)
+7. [Development](#development)
+8. [Release Notes/Contributors](#release-notescontributors)
## Overview
## Module Description
-Deploys OpenDaylight to various OSs either via an RPM or directly from the
-ODL tarball release artifact.
+Deploys OpenDaylight to various OSs either via an RPM or a Deb.
All OpenDaylight configuration should be handled through the ODL Puppet
module's [params](#parameters). If you need a new knob, [please raise an
Issue][8].
-Both supported [install methods](#install-method) default to the latest
-stable OpenDaylight release, which is currently [a Beryllium ERP][18].
+By default, the master branch installs OpenDaylight from the latest testing RPM repository
+or from the latest stable Deb repository depending on the OS. There are stable/<release>
+branches that install OpenDaylight releases and service releases, like Beryllium or Beryllium SR3.
## Setup
### 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] for OpenDaylight.
+- Manipulates OpenDaylight's configuration files according to the params
+ passed to the `::opendaylight` class.
+- Starts the `opendaylight` systemd service.
### Beginning with `opendaylight`
Getting started with the OpenDaylight Puppet module is as simple as declaring
the `::opendaylight` class.
-The [vagrant-opendaylight][11] project provides an easy way to experiment
-with [applying the ODL Puppet module][12] to CentOS 7, Fedora 22 and Fedora
-23 Vagrant boxes.
+The [vagrant-opendaylight][11] project provides an easy way to experiment with
+[applying the ODL Puppet module][12] to VMs.
```
-[~/vagrant-opendaylight]$ vagrant status
-Current machine states:
-
-cent7 not created (libvirt)
-cent7_rpm_he_sr4 not created (libvirt)
-cent7_rpm_li_sr2 not created (libvirt)
-cent7_rpm_be not created (libvirt)
-cent7_ansible not created (libvirt)
-cent7_ansible_be not created (libvirt)
-cent7_ansible_path not created (libvirt)
-cent7_pup_rpm not created (libvirt)
-cent7_pup_custom_logs not created (libvirt)
-cent7_pup_tb not created (libvirt)
-f22_rpm_li not created (libvirt)
-f22_ansible not created (libvirt)
-f22_pup_rpm not created (libvirt)
-f23_rpm_li not created (libvirt)
-f23_rpm_li_sr1 not created (libvirt)
-f23_rpm_li_sr2 not created (libvirt)
-f23_rpm_li_sr3 not created (libvirt)
-f23_rpm_be not created (libvirt)
-f23_ansible not created (libvirt)
-f23_pup_rpm not created (libvirt)
-
-[~/vagrant-opendaylight]$ vagrant up cent7_pup_rpm
-# A CentOS 7 VM is created and configured using the ODL Puppet mod's defaults
-[~/vagrant-opendaylight]$ vagrant ssh cent7_pup_rpm
-[vagrant@localhost ~]$ sudo systemctl is-active opendaylight
+# Provision a CentOS VM using puppet-opendaylight
+$ vagrant up cent7_pup_rpm
+$ vagrant ssh cent7_pup_rpm
+$ sudo systemctl is-active opendaylight
active
```
```puppet
class { 'opendaylight':
- extra_features => ['odl-ovsdb-plugin', 'odl-ovsdb-openstack'],
+ extra_features => ['odl-netvirt-openstack'],
}
```
}
```
-### Install Method
+### RPM Repo
+
+The `rpm_repo` param can be used to configure which RPM repository
+OpenDaylight is installed from.
+
+```puppet
+class { 'opendaylight':
+ rpm_repo => 'opendaylight-40-release',
+}
+```
+
+The naming convention follows the naming convention of the CentOS Community
+Build System, which is where upstream ODL hosts its RPMs. The
+`opendaylight-40-release` example above would install OpenDaylight Beryllium
+4.0.0 from the [nfv7-opendaylight-40-release][18] repo. Repo names ending in
+`-release` will always contain well-tested, officially released versions of
+OpenDaylight. Repos ending in `-testing` contain frequent, but unstable and
+unofficial, releases. The ODL version given in repo names shows which major
+and minor version it is pinned to. The `opendaylight-40-release` repo will
+always provide OpenDaylight Beryllium 4.0, whereas `opendaylight-4-release`
+will provide the latest release with major version 4 (which could include
+Service Releases, like SR2 4.2).
+
+For a full list of OpenDaylight releases and their CBS repos, see the
+[OpenDaylight Deployment wiki][19].
-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.
+This is only read for RedHat based operating systems. For Debian based OSs,
+this values is `none`.
-It's recommended that most people use the default RPM-based install.
+### Deb Repo
-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.
+The `deb_repo` param can be used to configure which Deb repository
+OpenDaylight is installed from.
```puppet
class { 'opendaylight':
- install_method => 'tarball',
- tarball_url => '<URL to your custom tarball>',
- unitfile_url => '<URL to your custom unitfile>',
+ deb_repo => 'ppa:odl-team/boron',
}
```
+The naming convention is same as the naming convention of Launchpad PPA's,
+which is where ODL .debs are hosted. The `ppa:odl-team/boron` example above
+would install OpenDaylight Boron realease from the [odl-team's boron][20] repo.
+
+This is only read for Debian based operating systems. For RedHat based OSs,
+this values is `none`.
+
### Ports
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',
}
```
+### Log Verbosity
+
+It's possible to define custom logger verbosity levels via the `log_levels`
+param.
+
+```puppet
+class { 'opendaylight':
+ log_levels => { 'org.opendaylight.ovsdb' => 'TRACE', 'org.opendaylight.ovsdb.lib' => 'INFO' },
+}
+```
+
+### Enabling ODL HA
+
+To enable ODL HA, use the `enable_ha` flag. It's disabled by default.
+
+When `enable_ha` is set to true the `ha_node_ips` should be populated with the
+IP addresses that ODL will listen on for each node in the HA cluster and
+`ha_node_index` should be set with the index of the IP address from
+`ha_node_ips` for the particular node that puppet is configuring as part of the
+HA cluster.
+
+```puppet
+class { 'opendaylight':
+ enable_ha => true,
+ ha_node_ips => ['10.10.10.1', '10.10.10.1', '10.10.10.3'],
+ ha_node_index => 0,
+}
+```
+
## Reference
### Classes
#### 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 a Deb.
+- `::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 `
+##### `odl_rest_port`
-Specifies the install method by which to install OpenDaylight.
+Specifies the port for the ODL northbound REST interface to listen on.
-The RPM install method is less complex, more frequently consumed and
-recommended.
+Default: `'8080'`
-Default: `'rpm'`
+Valid options: A valid port number as a string or integer.
-Valid options: The strings `'tarball'` or `'rpm'`.
+##### `rpm_repo`
-##### `odl_rest_port `
+OpenDaylight CentOS CBS repo to install RPM from (opendaylight-4-testing,
+opendaylight-40-release, ...).
-Specifies the port for the ODL northbound REST interface to listen on.
+##### `deb_repo`
-Default: `'8080'`
+OpenDaylight Launchpad PPA repo to install .deb from (ppa:odl-team/boron,
+ppa:odl-team/carbon, ...).
-Valid options: A valid port number as a string or integer.
+##### `log_levels`
+
+Custom OpenDaylight logger verbosity configuration.
+
+Default: `{}`
+
+Valid options: A hash of loggers to log levels.
+
+```
+{ 'org.opendaylight.ovsdb' => 'TRACE', 'org.opendaylight.ovsdb.lib' => 'INFO' }
+```
+
+Valid log levels are TRACE, DEBUG, INFO, WARN, and ERROR.
+
+The above example would add the following logging configuration to
+`/opt/opendaylight/etc/org.ops4j.pax.logging.cfg`.
+
+```
+# Log level config added by puppet-opendaylight
+log4j.logger.org.opendaylight.ovsdb = TRACE
+
+# Log level config added by puppet-opendaylight
+log4j.logger.org.opendaylight.ovsdb.lib = INFO
+```
-##### `tarball_url`
+To view loggers and their verbosity levels, use `log:list` at the ODL Karaf shell.
-Specifies the ODL tarball to use when installing via the tarball install
-method.
+```
+opendaylight-user@root>log:list
+Logger | Level
+----------------------------------
+ROOT | INFO
+org.opendaylight.ovsdb | TRACE
+org.opendaylight.ovsdb.lib | INFO
+```
+
+The main log output file is `/opt/opendaylight/data/log/karaf.log`.
+
+##### `enable_ha`
+
+Enable or disable ODL High Availablity.
+
+Default: `false`
+
+Valid options: The boolean values `true` and `false`.
+
+Requires: `ha_node_ips`, `ha_node_index`
+
+The ODL Clustering XML for HA are configured and enabled.
+
+##### `ha_node_ips`
+
+Specifies the IPs that are part of the HA cluster enabled by `enable_ha`.
+
+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_index`
+
+Specifies the index of the IP for the node being configured from the array `ha_node_ips`.
+
+Default: ''
+
+Valid options: Index of a member of the array `ha_node_ips`: `0`.
+
+Required by: `enable_ha`, `ha_node_ips`
+
+##### `security_group_mode`
+
+Specifies the mode to use for security groups.
+
+Default: `stateful`
+
+Valid options: `transparent`, `learn`, `stateless`
+
+##### `vpp_routing_node`
+
+Specifies the routing node for VPP deployment. A non-empty string will create config file
+org.opendaylight.groupbasedpolicy.neutron.vpp.mapper.startup.cfg with routing-node set.
-Default: `'https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/integration/distribution-karaf/0.3.2-Lithium-SR2/distribution-karaf-0.3.2-Lithium-SR2.tar.gz'`
+Default: `''`
-Valid options: A valid URL to an ODL tarball as a string.
+Valid options: A valid host name to a VPP node handling routing.
-##### `unitfile_url`
+##### `java_opts`
-Specifies the ODL systemd .service file to use when installing via the tarball
-install method.
+Specifies the Java options to run ODL with as a string.
-It's very unlikely that you'll need to override this.
+Default: `'-Djava.net.preferIPv4Stack=true'`
-Default: `'https://github.com/dfarrell07/opendaylight-systemd/archive/master/opendaylight-unitfile.tar.gz'`
+Valid options: A string of valid Java options.
-Valid options: A valid URL to an ODL systemd .service file (archived in a
-tarball) as a string.
+##### `username`
+
+Specifies the username to set for admin role in ODL.
+
+Default: `'admin'`
+
+Valid options: A username string.
+
+##### `password`
+
+Specifies the password to set for admin role in ODL.
+
+Default: `'admin'`
+
+Valid options: A password string.
## 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 CentOS 7 and Ubuntu 16.04.
+- Fedora is allowed but not well-tested, no Beaker coverage.
## 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
-[3]: https://gitter.im/dfarrell07/puppet-opendaylight?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-[4]: https://travis-ci.org/dfarrell07/puppet-opendaylight.svg
-[5]: https://gemnasium.com/dfarrell07/puppet-opendaylight.svg
-[6]: https://badges.gitter.im/Join%20Chat.svg
+
+[4]: https://travis-ci.org/dfarrell07/puppet-opendaylight.svg?branch=master
+
+[5]: https://gemnasium.com/dfarrell07/puppet-opendaylight.svg?branch=master
+
[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-4-testing/x86_64/os/Packages/
+
+[18]: http://cbs.centos.org/repos/nfv7-opendaylight-40-release/x86_64/os/Packages/ "OpenDaylight Beryllium CentOS CBS repo"
+
+[18]: https://wiki.opendaylight.org/view/Deployment#RPM "OpenDaylight RPMs and their repos"
+
+[20]: https://launchpad.net/~odl-team/+archive/ubuntu/boron
Code Review / integration / packaging / puppet-opendaylight.git / blobdiff