Merge "Bump Puppet version 4.x to 5.x"

[integration/packaging/puppet-opendaylight.git] / README.markdown

diff --git a/README.markdown b/README.markdown
index 1c7f932e2948ff9b214299ea76083b3e0bf5de23..6ceaf65e4020f09e81830004918f74745a1877d8 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -96,7 +96,7 @@ OpenDaylight is installed from.
 
 ```puppet
 class { 'opendaylight':
-  rpm_repo => 'https://nexus.opendaylight.org/content/repositories/opendaylight-fluorine-epel-7-$basearch-devel',
+  rpm_repo => 'https://nexus.opendaylight.org/content/repositories/opendaylight-neon-epel-7-$basearch-devel',
 }
 ```
 
@@ -307,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.
 
@@ -319,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.
@@ -333,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.
@@ -435,6 +488,14 @@ 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.