Skip to content

Commit 43fc74f

Browse files
committed
puppet strings
1 parent aa58ca1 commit 43fc74f

File tree

1 file changed

+38
-14
lines changed

1 file changed

+38
-14
lines changed

REFERENCE.md

+38-14
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,9 @@ copying files from the `configdir` to instance `configdir`s.
297297

298298
Data type: `String`
299299

300-
File pattern for the file appender log when file_rolling_type is 'dailyRollingFile'.
300+
DEPRECATED, File pattern for the file appender log when file_rolling_type is 'dailyRollingFile'.
301+
302+
Default value: `"'.'yyyy-MM-dd"`
301303

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

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

310312
Data type: `String`
311313

312-
Default logging level for Elasticsearch.
314+
DEPRECATED, Default logging level for Elasticsearch.
313315

314-
Default value: `$logging_level`
316+
Default value: `'INFO'`
315317

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

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

324326
Data type: `Boolean`
325327

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

331+
Default value: `false`
332+
329333
##### <a name="-elasticsearch--deprecation_logging_level"></a>`deprecation_logging_level`
330334

331335
Data type: `String`
332336

333-
Default deprecation logging level for Elasticsearch.
337+
DEPRECATED, Default deprecation logging level for Elasticsearch.
338+
339+
Default value: `'DEBUG'`
334340

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

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

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

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

382+
Default value: `'dailyRollingFile'`
383+
376384
##### <a name="-elasticsearch--homedir"></a>`homedir`
377385

378386
Data type: `Stdlib::Absolutepath`
@@ -449,28 +457,36 @@ Default value: `'2750'`
449457

450458
Data type: `Hash`
451459

452-
Representation of information to be included in the log4j.properties file.
460+
DEPRECATED, Representation of information to be included in the log4j.properties file.
461+
462+
Default value: `{}`
453463

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

456466
Data type: `Optional[String]`
457467

458-
Instead of a hash, you may supply a `puppet://` file source for the
468+
DEPRECATED, Instead of a hash, you may supply a `puppet://` file source for the
459469
log4j.properties file.
460470

471+
Default value: `undef`
472+
461473
##### <a name="-elasticsearch--logging_level"></a>`logging_level`
462474

463475
Data type: `String`
464476

465477
Default logging level for Elasticsearch.
466478

479+
Default value: `'INFO'`
480+
467481
##### <a name="-elasticsearch--logging_template"></a>`logging_template`
468482

469-
Data type: `Optional[String]`
483+
Data type: `String`
470484

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

488+
Default value: `"${module_name}/etc/elasticsearch/log4j2.properties.erb"`
489+
474490
##### <a name="-elasticsearch--manage_datadir"></a>`manage_datadir`
475491

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

663679
Data type: `Integer`
664680

665-
Max number of logs to store whern file_rolling_type is 'rollingFile'
681+
DEPRECATED, Max number of logs to store whern file_rolling_type is 'rollingFile'
682+
683+
Default value: `1`
666684

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

669687
Data type: `String`
670688

671-
Max log file size when file_rolling_type is 'rollingFile'
689+
DEPRECATED, Max log file size when file_rolling_type is 'rollingFile'
690+
691+
Default value: `'10MB'`
672692

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

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

688708
Data type: `Optional[String]`
689709

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

713+
Default value: `undef`
714+
693715
##### <a name="-elasticsearch--security_logging_source"></a>`security_logging_source`
694716

695717
Data type: `Optional[String]`
696718

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

722+
Default value: `undef`
723+
700724
##### <a name="-elasticsearch--service_name"></a>`service_name`
701725

702726
Data type: `String`

0 commit comments

Comments
 (0)