Merge "Bump Puppet version 4.x to 5.x"
[integration/packaging/puppet-opendaylight.git] / README.markdown
index 13603999525cdbf817ca9779d7a0d7d271054c84..6ceaf65e4020f09e81830004918f74745a1877d8 100644 (file)
@@ -96,7 +96,7 @@ OpenDaylight is installed from.
 
 ```puppet
 class { 'opendaylight':
-  rpm_repo => 'https://nexus.opendaylight.org/content/repositories/opendaylight-oxygen-epel-7-$basearch-devel',
+  rpm_repo => 'https://nexus.opendaylight.org/content/repositories/opendaylight-neon-epel-7-$basearch-devel',
 }
 ```
 
@@ -116,13 +116,13 @@ OpenDaylight is installed from.
 
 ```puppet
 class { 'opendaylight':
-  deb_repo => 'ppa:odl-team/carbon',
+  deb_repo => 'ppa:odl-team/nitrogen',
 }
 ```
 
 The naming convention is same as the naming convention of Launchpad PPA's,
-which is where ODL .debs are hosted. The `ppa:odl-team/carbon` example above
-would install OpenDaylight Carbon from the [Boron launchpad repo][3].
+which is where ODL .debs are hosted. The `ppa:odl-team/nitrogen` example above
+would install OpenDaylight Nitrogen from the [Nitrogen launchpad repo][3].
 
 This is only read for Debian-family operating systems.
 
@@ -133,7 +133,7 @@ calls, use the `odl_rest_port` param.
 
 ```puppet
 class { 'opendaylight':
-  odl_rest_port => '8080',
+  odl_rest_port => '8181',
 }
 ```
 
@@ -247,7 +247,7 @@ Valid options: A list of Karaf feature names as strings.
 
 Specifies the port for the ODL northbound REST interface to listen on.
 
-Default: `'8080'`
+Default: `'8181'`
 
 Valid options: A valid port number as a string or integer.
 
@@ -258,7 +258,7 @@ Repo URL to install ODL RPM from, in .repo baseurl format.
 ##### `deb_repo`
 
 OpenDaylight Launchpad PPA repo to install .deb from (ppa:odl-team/boron,
-ppa:odl-team/carbon, ...).
+ppa:odl-team/nitrogen, ...).
 
 ##### `log_levels`
 
@@ -279,10 +279,12 @@ The above example would add the following logging configuration to
 
 ```
 # Log level config added by puppet-opendaylight
-log4j.logger.org.opendaylight.ovsdb = TRACE
+log4j2.logger.org_opendaylight_ovsdb.level = TRACE
+log4j2.logger.org_opendaylight_ovsdb.name = org.opendaylight.ovsdb
 
 # Log level config added by puppet-opendaylight
-log4j.logger.org.opendaylight.ovsdb.lib = INFO
+log4j2.logger.org_opendaylight_ovsdb_lib.level = INFO
+log4j2.logger.org_opendaylight_ovsdb_lib.name = org.opendaylight.ovsdb.lib
 ```
 
 To view loggers and their verbosity levels, use `log:list` at the ODL Karaf shell.
@@ -305,7 +307,7 @@ Maximum size of OpenDaylight's log file, `/opt/opendaylight/data/log/karaf.log`.
 Once this size is reached, the log will be rolled over, with up to
 `log_max_rollover` log rollovers preserved in total.
 
-Default: `10GB`
+Default: `500MB`
 
 Valid options: A valid size as a string with unit specified.
 
@@ -317,10 +319,28 @@ Note that if this is set to 1, log rollovers will result in loosing newly
 logged data. It's recommended to use values greater than one to prune from
 the end of the log.
 
-Default: `2`
+Default: `4`
 
 Valid options: An integer greater than 0.
 
+##### `log_rollover_fileindex`
+
+String that controls file index to use when log rollovers are initiated.
+
+If set to 'max', files with a higher index will be newer than files with
+a smaller index.
+
+If set to 'min', file with a lower index will be newer than files with a
+higher index.
+
+If set to 'nomax', the min and max values will be ignored, and file
+numbering will increment by 1 and each rollover will have an
+incrementally higher value with no maximum number of files.
+
+Default: `min`
+
+Valid options: 'min', 'max', 'nomax'
+
 ##### `log_mechanism`
 
 Logging mechanism for karaf logs. They are logged either to a file or console.
@@ -331,6 +351,41 @@ Default: `file`
 
 Valid options: `file`, `console`.
 
+##### `log_pattern`
+
+String that controls the log pattern used for logging.
+
+Default: `%d{ISO8601} | %-5p | %-16t | %-60c{6} | %m%n`
+
+Valid options: A valid string that is a valid log4j2 pattern.
+
+##### `enable_paxosgi_logger`
+
+Boolean that controls whether the PaxOsgi appender is enabled for logging.
+
+Note that enabling this will also require to modify the log pattern to
+make use of the added capabilities. To do so the variable `log_pattern` should
+be overriden to include a pattern that includes the tokens that PaxOsgi adds.
+
+This could be achieving, for example, by setting `log_pattern` to a string
+that includes:
+
+'%X{bundle.id} - %X{bundle.name} - %X{bundle.version}'
+
+Failure to change the `log_pattern` will mean that the PaxOsgi appender will
+be enabled but the added functionality not used on the logging. This has no
+negative effect on the system and it will continue to run, just it will not
+include the added information one could get from PaxOsgi.
+
+A good example would be to set this variable to `true` and set `log_pattern`
+to:
+
+'%d{ISO8601} | %-5p | %-16t | %-32c{1} | %X{bundle.id} - %X{bundle.name} - %X{bundle.version} | %m%n'
+
+Default: `false`
+
+Valid options: The boolean values `true` and `false`.
+
 ##### `enable_ha`
 
 Enable or disable ODL High Availablity.
@@ -392,9 +447,11 @@ Valid options: A valid host name to a VPP node handling routing.
 
 ##### `java_opts`
 
-Specifies the Java options to run ODL with as a string.
+Specifies the Java options to run ODL with as a string. Note, these options
+are in addition to the default Java options set by the karaf/ODL boot scripts
+and IP version based flag set by 'opendaylight' class.
 
-Default: `'-Djava.net.preferIPv4Stack=true'`
+Default: `''`
 
 Valid options: A string of valid Java options.
 
@@ -414,6 +471,31 @@ Default: `'admin'`
 
 Valid options: A password string.
 
+### `inherit_dscp_marking`
+
+Specifies whether DSCP marking is enabled for packets egressing out of OVS through
+VXLAN/GRE tunnels.
+
+Default: `false`
+
+Valid options: `true`, `false`
+
+### `stats_polling_enabled`
+
+Enables statistics polling of OpenFlow entities like table, groups.
+
+Default: `false`
+
+Valid options: `true`, `false`
+
+### `inactivity_probe`
+
+Configures inactivity probe timer when specified.
+
+Default: `undef`
+
+Valid options: An integer or string in milliseconds.
+
 ## Limitations
 
 - Tested on CentOS 7 and Ubuntu 16.04.
@@ -434,7 +516,7 @@ See the [CHANGELOG][5] for information about releases.
 
 [2]: http://docs.opendaylight.org/en/latest/submodules/integration/packaging/docs/rpms.html#repositories "ODL RPM repo docs"
 
-[3]: https://launchpad.net/~odl-team/+archive/ubuntu/carbon "ODL Carbon Deb repo"
+[3]: https://launchpad.net/~odl-team/+archive/ubuntu/nitrogen "ODL Nitrogen Deb repo"
 
 [4]: https://git.opendaylight.org/gerrit/gitweb?p=integration/packaging/puppet-opendaylight.git;a=blob;f=CONTRIBUTING.markdown "Contributing docs"