Skip to content

Commit

Permalink
puppet strings
Browse files Browse the repository at this point in the history
  • Loading branch information
stjmt committed Jul 31, 2024
1 parent aa58ca1 commit 43fc74f
Showing 1 changed file with 38 additions and 14 deletions.
52 changes: 38 additions & 14 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,9 @@ copying files from the `configdir` to instance `configdir`s.

Data type: `String`

File pattern for the file appender log when file_rolling_type is 'dailyRollingFile'.
DEPRECATED, File pattern for the file appender log when file_rolling_type is 'dailyRollingFile'.

Default value: `"'.'yyyy-MM-dd"`

##### <a name="-elasticsearch--datadir"></a>`datadir`

Expand All @@ -309,9 +311,9 @@ Allows you to set the data directory of Elasticsearch.

Data type: `String`

Default logging level for Elasticsearch.
DEPRECATED, Default logging level for Elasticsearch.

Default value: `$logging_level`
Default value: `'INFO'`

##### <a name="-elasticsearch--defaults_location"></a>`defaults_location`

Expand All @@ -323,14 +325,18 @@ Absolute path to directory containing init defaults file.

Data type: `Boolean`

Whether to enable deprecation logging. If enabled, deprecation logs will be
DEPRECATED, Whether to enable deprecation logging. If enabled, deprecation logs will be
saved to ${cluster.name}_deprecation.log in the Elasticsearch log folder.

Default value: `false`

##### <a name="-elasticsearch--deprecation_logging_level"></a>`deprecation_logging_level`

Data type: `String`

Default deprecation logging level for Elasticsearch.
DEPRECATED, Default deprecation logging level for Elasticsearch.

Default value: `'DEBUG'`

##### <a name="-elasticsearch--download_tool"></a>`download_tool`

Expand Down Expand Up @@ -369,10 +375,12 @@ The user Elasticsearch should run as. This also sets file ownership.

Data type: `Enum['dailyRollingFile', 'rollingFile', 'file']`

Configuration for the file appender rotation. It can be 'dailyRollingFile',
DEPRECATED, Configuration for the file appender rotation. It can be 'dailyRollingFile',
'rollingFile' or 'file'. The first rotates by name, the second one by size
or third don't rotate automatically.

Default value: `'dailyRollingFile'`

##### <a name="-elasticsearch--homedir"></a>`homedir`

Data type: `Stdlib::Absolutepath`
Expand Down Expand Up @@ -449,28 +457,36 @@ Default value: `'2750'`

Data type: `Hash`

Representation of information to be included in the log4j.properties file.
DEPRECATED, Representation of information to be included in the log4j.properties file.

Default value: `{}`

##### <a name="-elasticsearch--logging_file"></a>`logging_file`

Data type: `Optional[String]`

Instead of a hash, you may supply a `puppet://` file source for the
DEPRECATED, Instead of a hash, you may supply a `puppet://` file source for the
log4j.properties file.

Default value: `undef`

##### <a name="-elasticsearch--logging_level"></a>`logging_level`

Data type: `String`

Default logging level for Elasticsearch.

Default value: `'INFO'`

##### <a name="-elasticsearch--logging_template"></a>`logging_template`

Data type: `Optional[String]`
Data type: `String`

Use a custom logging template - just supply the relative path, i.e.
DEPRECATED, Use a custom logging template - just supply the relative path, i.e.
`$module/elasticsearch/logging.yml.erb`

Default value: `"${module_name}/etc/elasticsearch/log4j2.properties.erb"`

##### <a name="-elasticsearch--manage_datadir"></a>`manage_datadir`

Data type: `Boolean`
Expand Down Expand Up @@ -662,13 +678,17 @@ Define roles via a hash. This is mainly used with Hiera's auto binding.

Data type: `Integer`

Max number of logs to store whern file_rolling_type is 'rollingFile'
DEPRECATED, Max number of logs to store whern file_rolling_type is 'rollingFile'

Default value: `1`

##### <a name="-elasticsearch--rolling_file_max_file_size"></a>`rolling_file_max_file_size`

Data type: `String`

Max log file size when file_rolling_type is 'rollingFile'
DEPRECATED, Max log file size when file_rolling_type is 'rollingFile'

Default value: `'10MB'`

##### <a name="-elasticsearch--scripts"></a>`scripts`

Expand All @@ -687,16 +707,20 @@ Elasticsearch keystore file. If unset, the keystore is left unmanaged.

Data type: `Optional[String]`

File content for x-pack logging configuration file (will be placed
DEPRECATED, File content for x-pack logging configuration file (will be placed
into log4j2.properties file).

Default value: `undef`

##### <a name="-elasticsearch--security_logging_source"></a>`security_logging_source`

Data type: `Optional[String]`

File source for x-pack logging configuration file (will be placed
DEPRECATED, File source for x-pack logging configuration file (will be placed
into log4j2.properties).

Default value: `undef`

##### <a name="-elasticsearch--service_name"></a>`service_name`

Data type: `String`
Expand Down

0 comments on commit 43fc74f

Please sign in to comment.