Skip to content

Commit 2d78878

Browse files
author
Johan De Wit
committed
fix linter and regenerate REFERENCE.md
1 parent e18307f commit 2d78878

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

REFERENCE.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* [`mongodb::replset`](#mongodb--replset): Wrapper class useful for hiera based deployments
2020
* [`mongodb::repo::apt`](#mongodb--repo--apt): PRIVATE CLASS: do not use directly
2121
* [`mongodb::repo::yum`](#mongodb--repo--yum): PRIVATE CLASS: do not use directly
22-
* [`mongodb::server`](#mongodb--server): This setting can be used to specify if the service should be running.
22+
* [`mongodb::server`](#mongodb--server): This installs a MongoDB server.
2323
* [`mongodb::server::config`](#mongodb--server--config): PRIVATE CLASS: do not call directly
2424
* [`mongodb::server::install`](#mongodb--server--install): PRIVATE CLASS: do not call directly
2525
* [`mongodb::server::service`](#mongodb--server--service): PRIVATE CLASS: do not call directly
@@ -1197,8 +1197,30 @@ PRIVATE CLASS: do not use directly
11971197

11981198
### <a name="mongodb--server"></a>`mongodb::server`
11991199

1200+
Most of the parameters manipulate the mongod.conf file.
1201+
1202+
For more details about configuration parameters consult the MongoDB Configuration File Options.
1203+
1204+
}
1205+
12001206
This setting can be used to specify if the service should be running.
12011207

1208+
#### Examples
1209+
1210+
##### Basic usage.
1211+
1212+
```puppet
1213+
include mongodb::server
1214+
```
1215+
1216+
##### Overrule settings
1217+
1218+
```puppet
1219+
class {'mongodb::server':
1220+
port => 27018,
1221+
verbose => true,
1222+
```
1223+
12021224
#### Parameters
12031225

12041226
The following parameters are available in the `mongodb::server` class:

manifests/server.pp

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44
#
55
# For more details about configuration parameters consult the MongoDB Configuration File Options.
66
#
7-
# @example
8-
9-
7+
# @example Basic usage.
8+
# include mongodb::server
9+
#
10+
# @example Overrule settings
11+
# class {'mongodb::server':
12+
# port => 27018,
13+
# verbose => true,
14+
# }
15+
#
1016
# @param ensure
1117
# Used to ensure that the package is installed and the service is running, or that the package is
1218
# absent/purged and the service is stopped.

0 commit comments

Comments
 (0)