@@ -22,7 +22,6 @@ The module is based on **stdmod** naming standards version 0.9.0.
22
22
23
23
Refer to http://github.com/stdmod/ for complete documentation on the common parameters.
24
24
25
-
26
25
##Setup
27
26
28
27
###Resources managed by <%= metadata.name %> module
@@ -40,87 +39,106 @@ Refer to http://github.com/stdmod/ for complete documentation on the common para
40
39
41
40
To install the package provided by the module just include it:
42
41
43
- include <%= metadata . name %>
42
+ ```puppet
43
+ include <%= metadata . name %>
44
+ ```
44
45
45
46
The main class arguments can be provided either via Hiera (from Puppet 3.x) or direct parameters:
46
47
47
- class { '<%= metadata . name %> ':
48
- parameter => value,
49
- }
48
+ ```puppet
49
+ class { '<%= metadata . name %> ':
50
+ parameter => value,
51
+ }
52
+ ```
50
53
51
54
The module provides also a generic define to manage any <%= metadata . name %> configuration file:
52
55
53
- <%= metadata . name %> ::conf { 'sample.conf':
54
- content => '# Test',
55
- }
56
-
56
+ ```puppet
57
+ <%= metadata . name %> ::conf { 'sample.conf':
58
+ content => '# Test',
59
+ }
60
+ ```
57
61
58
62
##Usage
59
63
60
64
* A common way to use this module involves the management of the main configuration file via a custom template (provided in a custom site module):
61
65
62
- class { '<%= metadata . name %> ':
63
- config_file_template => 'site/<%= metadata . name %> /<%= metadata . name %> .conf.erb',
64
- }
66
+ ```puppet
67
+ class { '<%= metadata . name %> ':
68
+ config_file_template => 'site/<%= metadata . name %> /<%= metadata . name %> .conf.erb',
69
+ }
70
+ ```
65
71
66
72
* You can write custom templates that use setting provided but the config_file_options_hash paramenter
67
73
68
- class { '<%= metadata . name %> ':
69
- config_file_template => 'site/<%= metadata . name %> /<%= metadata . name %> .conf.erb',
70
- config_file_options_hash => {
71
- opt => 'value',
72
- opt2 => 'value2',
73
- },
74
- }
74
+ ```puppet
75
+ class { '<%= metadata . name %> ':
76
+ config_file_template => 'site/<%= metadata . name %> /<%= metadata . name %> .conf.erb',
77
+ config_file_options_hash => {
78
+ opt => 'value',
79
+ opt2 => 'value2',
80
+ },
81
+ }
82
+ ```
75
83
76
84
* Use custom source (here an array) for main configuration file. Note that template and source arguments are alternative.
77
85
78
- class { '<%= metadata . name %> ':
79
- config_file_source => [ "puppet:///modules/site/<%= metadata . name %> /<%= metadata . name %> .conf-${hostname}" ,
80
- "puppet:///modules/site/<%= metadata . name %> /<%= metadata . name %> .conf" ],
81
- }
82
-
86
+ ```puppet
87
+ class { '<%= metadata . name %> ':
88
+ config_file_source => [ "puppet:///modules/site/<%= metadata . name %> /<%= metadata . name %> .conf-${hostname}" ,
89
+ "puppet:///modules/site/<%= metadata . name %> /<%= metadata . name %> .conf" ],
90
+ }
91
+ ```
83
92
84
93
* Use custom source directory for the whole configuration directory, where present.
85
94
86
- class { '<%= metadata . name %> ':
87
- config_dir_source => 'puppet:///modules/site/<%= metadata . name %> /conf/',
88
- }
95
+ ```puppet
96
+ class { '<%= metadata . name %> ':
97
+ config_dir_source => 'puppet:///modules/site/<%= metadata . name %> /conf/',
98
+ }
99
+ ```
89
100
90
101
* Use custom source directory for the whole configuration directory and purge all the local files that are not on the dir.
91
102
Note: This option can be used to be sure that the content of a directory is exactly the same you expect, but it is desctructive and may remove files.
92
103
93
- class { '<%= metadata . name %> ':
94
- config_dir_source => 'puppet:///modules/site/<%= metadata . name %> /conf/',
95
- config_dir_purge => true, # Default: false.
96
- }
104
+ ```puppet
105
+ class { '<%= metadata . name %> ':
106
+ config_dir_source => 'puppet:///modules/site/<%= metadata . name %> /conf/',
107
+ config_dir_purge => true, # Default: false.
108
+ }
109
+ ```
97
110
98
111
* Use custom source directory for the whole configuration dir and define recursing policy.
99
112
100
- class { '<%= metadata . name %> ':
101
- config_dir_source => 'puppet:///modules/site/<%= metadata . name %> /conf/',
102
- config_dir_recursion => false, # Default: true.
103
- }
113
+ ```puppet
114
+ class { '<%= metadata . name %> ':
115
+ config_dir_source => 'puppet:///modules/site/<%= metadata . name %> /conf/',
116
+ config_dir_recursion => false, # Default: true.
117
+ }
118
+ ```
104
119
105
120
* Provide an hash of files resources to be created with <%= metadata . name %> ::conf.
106
121
107
- class { '<%= metadata . name %> ':
108
- conf_hash => {
109
- '<%= metadata . name %> .conf' => {
110
- template => 'site/<%= metadata . name %> /<%= metadata . name %> .conf',
111
- },
112
- '<%= metadata . name %> .other.conf' => {
113
- template => 'site/<%= metadata . name %> /<%= metadata . name %> .other.conf',
114
- },
115
- },
116
- }
122
+ ```puppet
123
+ class { '<%= metadata . name %> ':
124
+ conf_hash => {
125
+ '<%= metadata . name %> .conf' => {
126
+ template => 'site/<%= metadata . name %> /<%= metadata . name %> .conf',
127
+ },
128
+ '<%= metadata . name %> .other.conf' => {
129
+ template => 'site/<%= metadata . name %> /<%= metadata . name %> .other.conf',
130
+ },
131
+ },
132
+ }
133
+ ```
117
134
118
135
* Do not trigger a service restart when a config file changes.
119
136
120
- class { '<%= metadata . name %> ':
121
- config_dir_notify => '', # Default: Service[<%= metadata . name %> ]
122
- }
123
-
137
+ ```puppet
138
+ class { '<%= metadata . name %> ':
139
+ config_dir_notify => '', # Default: Service[<%= metadata . name %> ]
140
+ }
141
+ ```
124
142
125
143
##Operating Systems Support
126
144
@@ -129,7 +147,6 @@ This is tested on these OS:
129
147
- Debian 6 and 7
130
148
- Ubuntu 10.04 and 12.04
131
149
132
-
133
150
##Development
134
151
135
152
Pull requests (PR) and bug reports via GitHub are welcomed.
0 commit comments