7
7
### Classes
8
8
9
9
* [ ` pe_databases ` ] ( #pe_databases ) : Tuning, maintenance for PE PostgreSQL.
10
- * [ ` pe_databases::pg_repack ` ] ( #pe_databasespg_repack ) : Provides systemd timers to pg_repack tables in the pe-puppetdb database
10
+ * [ ` pe_databases::pg_repack ` ] ( #pe_databases--pg_repack ) : Provides systemd timers to pg_repack tables in a given database
11
11
12
12
### Defined types
13
13
14
- * [ ` pe_databases::collect ` ] ( #pe_databasescollect ) : Create systemd units for repacking a given database type
14
+ * [ ` pe_databases::collect ` ] ( #pe_databases--collect ) : Create systemd units for repacking a given database type
15
15
16
16
### Tasks
17
17
@@ -27,227 +27,274 @@ Tuning, maintenance for PE PostgreSQL.
27
27
28
28
The following parameters are available in the ` pe_databases ` class:
29
29
30
- * [ ` manage_database_maintenance ` ] ( #manage_database_maintenance )
31
- * [ ` disable_maintenance ` ] ( #disable_maintenance )
32
- * [ ` install_dir ` ] ( #install_dir )
33
- * [ ` scripts_dir ` ] ( #scripts_dir )
34
- * [ ` facts_tables_repack_timer ` ] ( #facts_tables_repack_timer )
35
- * [ ` catalogs_tables_repack_timer ` ] ( #catalogs_tables_repack_timer )
36
- * [ ` other_tables_repack_timer ` ] ( #other_tables_repack_timer )
37
- * [ ` manage_postgresql_settings ` ] ( #manage_postgresql_settings )
38
- * [ ` manage_table_settings ` ] ( #manage_table_settings )
39
- * [ ` reports_tables_repack_timer ` ] ( #reports_tables_repack_timer )
40
- * [ ` resource_events_tables_repack_timer ` ] ( #resource_events_tables_repack_timer )
41
-
42
- ##### <a name =" manage_database_maintenance " ></a >` manage_database_maintenance `
30
+ * [ ` manage_database_maintenance ` ] ( #-pe_databases--manage_database_maintenance )
31
+ * [ ` disable_maintenance ` ] ( #-pe_databases--disable_maintenance )
32
+ * [ ` install_dir ` ] ( #-pe_databases--install_dir )
33
+ * [ ` scripts_dir ` ] ( #-pe_databases--scripts_dir )
34
+ * [ ` facts_tables_repack_timer ` ] ( #-pe_databases--facts_tables_repack_timer )
35
+ * [ ` catalogs_tables_repack_timer ` ] ( #-pe_databases--catalogs_tables_repack_timer )
36
+ * [ ` other_tables_repack_timer ` ] ( #-pe_databases--other_tables_repack_timer )
37
+ * [ ` activity_tables_repack_timer ` ] ( #-pe_databases--activity_tables_repack_timer )
38
+ * [ ` manage_postgresql_settings ` ] ( #-pe_databases--manage_postgresql_settings )
39
+ * [ ` manage_table_settings ` ] ( #-pe_databases--manage_table_settings )
40
+ * [ ` reports_tables_repack_timer ` ] ( #-pe_databases--reports_tables_repack_timer )
41
+ * [ ` resource_events_tables_repack_timer ` ] ( #-pe_databases--resource_events_tables_repack_timer )
42
+
43
+ ##### <a name =" -pe_databases--manage_database_maintenance " ></a >` manage_database_maintenance `
43
44
44
45
Data type: ` Boolean `
45
46
46
47
true or false (Default: true)
47
48
Manage the inclusion of the pg_repack class
48
49
49
- Default value: `` true ` `
50
+ Default value: ` true `
50
51
51
- ##### <a name =" disable_maintenance " ></a >` disable_maintenance `
52
+ ##### <a name =" -pe_databases-- disable_maintenance" ></a >` disable_maintenance `
52
53
53
54
Data type: ` Boolean `
54
55
55
56
true or false (Default: false)
56
57
Disable or enable maintenance mode
57
58
58
- Default value: `` false ` `
59
+ Default value: ` false `
59
60
60
- ##### <a name =" install_dir " ></a >` install_dir `
61
+ ##### <a name =" -pe_databases-- install_dir" ></a >` install_dir `
61
62
62
63
Data type: ` String[1] `
63
64
64
65
Directory to install module into (Default: "/opt/puppetlabs/pe_databases")
65
66
66
67
Default value: ` '/opt/puppetlabs/pe_databases' `
67
68
68
- ##### <a name =" scripts_dir " ></a >` scripts_dir `
69
+ ##### <a name =" -pe_databases-- scripts_dir" ></a >` scripts_dir `
69
70
70
71
Data type: ` String[1] `
71
72
72
73
Directory to install scripts into (Default: "${install_dir}/scripts")
73
74
74
75
Default value: ` "${install_dir}/scripts" `
75
76
76
- ##### <a name =" facts_tables_repack_timer " ></a >` facts_tables_repack_timer `
77
+ ##### <a name =" -pe_databases-- facts_tables_repack_timer" ></a >` facts_tables_repack_timer `
77
78
78
79
Data type: ` String[1] `
79
80
80
81
The Systemd timer for the pg_repack job affecting the 'facts' tables
81
82
82
- Default value: ` 'Tue,Sat *-*-* 04:30:00' `
83
-
84
- ##### <a name =" catalogs_tables_repack_timer " ></a >` catalogs_tables_repack_timer `
83
+ ##### <a name =" -pe_databases--catalogs_tables_repack_timer " ></a >` catalogs_tables_repack_timer `
85
84
86
85
Data type: ` String[1] `
87
86
88
87
The Systemd timer for the pg_repack job affecting the 'catalog' tables
89
88
90
- Default value: ` 'Sun,Thu *-*-* 04:30:00' `
91
-
92
- ##### <a name =" other_tables_repack_timer " ></a >` other_tables_repack_timer `
89
+ ##### <a name =" -pe_databases--other_tables_repack_timer " ></a >` other_tables_repack_timer `
93
90
94
91
Data type: ` String[1] `
95
92
96
93
The Systemd timer for the pg_repack job affecting the 'other' tables
97
94
98
- Default value: ` '*-*-20 05:30:00' `
95
+ ##### < a name = " -pe_databases--activity_tables_repack_timer " ></ a > ` activity_tables_repack_timer `
99
96
100
- ##### < a name = " manage_postgresql_settings " ></ a > ` manage_postgresql_settings `
97
+ Data type: ` String[1] `
101
98
102
- Data type: ` Optional[Boolean] `
99
+ The Systemd timer for the pg_repack job affecting the 'activity' tables
103
100
101
+ ##### <a name =" -pe_databases--manage_postgresql_settings " ></a >` manage_postgresql_settings `
104
102
103
+ Data type: ` Optional[Boolean] `
105
104
106
- Default value: `` undef ``
105
+ Deprecated Parameter will be removed in future releases
107
106
108
- ##### < a name = " manage_table_settings " ></ a > ` manage_table_settings `
107
+ Default value: ` undef `
109
108
110
- Data type: ` Optional[Boolean] `
109
+ ##### < a name = " -pe_databases--manage_table_settings " ></ a > ` manage_table_settings `
111
110
111
+ Data type: ` Optional[Boolean] `
112
112
113
+ Deprecated Parameter will be removed in future releases
113
114
114
- Default value: `` undef ` `
115
+ Default value: ` undef `
115
116
116
- ##### <a name =" reports_tables_repack_timer " ></a >` reports_tables_repack_timer `
117
+ ##### <a name =" -pe_databases-- reports_tables_repack_timer" ></a >` reports_tables_repack_timer `
117
118
118
119
Data type: ` Optional[String] `
119
120
121
+ Deprecated Parameter will be removed in future releases
120
122
123
+ Default value: ` undef `
121
124
122
- Default value: `` undef ``
123
-
124
- ##### <a name =" resource_events_tables_repack_timer " ></a >` resource_events_tables_repack_timer `
125
+ ##### <a name =" -pe_databases--resource_events_tables_repack_timer " ></a >` resource_events_tables_repack_timer `
125
126
126
127
Data type: ` Optional[String] `
127
128
129
+ Deprecated Parameter will be removed in future releases
128
130
131
+ Default value: ` undef `
129
132
130
- Default value: `` undef ``
131
-
132
- ### <a name =" pe_databasespg_repack " ></a >` pe_databases::pg_repack `
133
+ ### <a name =" pe_databases--pg_repack " ></a >` pe_databases::pg_repack `
133
134
134
135
Maintenance pg_repack
135
136
136
137
#### Parameters
137
138
138
139
The following parameters are available in the ` pe_databases::pg_repack ` class:
139
140
140
- * [ ` disable_maintenance ` ] ( #disable_maintenance )
141
- * [ ` jobs ` ] ( #jobs )
142
- * [ ` facts_tables_repack_timer ` ] ( #facts_tables_repack_timer )
143
- * [ ` catalogs_tables_repack_timer ` ] ( #catalogs_tables_repack_timer )
144
- * [ ` other_tables_repack_timer ` ] ( #other_tables_repack_timer )
145
- * [ ` reports_tables_repack_timer ` ] ( #reports_tables_repack_timer )
146
- * [ ` resource_events_tables_repack_timer ` ] ( #resource_events_tables_repack_timer )
141
+ * [ ` fact_tables ` ] ( #-pe_databases--pg_repack--fact_tables )
142
+ * [ ` catalog_tables ` ] ( #-pe_databases--pg_repack--catalog_tables )
143
+ * [ ` other_tables ` ] ( #-pe_databases--pg_repack--other_tables )
144
+ * [ ` activity_tables ` ] ( #-pe_databases--pg_repack--activity_tables )
145
+ * [ ` disable_maintenance ` ] ( #-pe_databases--pg_repack--disable_maintenance )
146
+ * [ ` jobs ` ] ( #-pe_databases--pg_repack--jobs )
147
+ * [ ` facts_tables_repack_timer ` ] ( #-pe_databases--pg_repack--facts_tables_repack_timer )
148
+ * [ ` catalogs_tables_repack_timer ` ] ( #-pe_databases--pg_repack--catalogs_tables_repack_timer )
149
+ * [ ` other_tables_repack_timer ` ] ( #-pe_databases--pg_repack--other_tables_repack_timer )
150
+ * [ ` activity_tables_repack_timer ` ] ( #-pe_databases--pg_repack--activity_tables_repack_timer )
151
+ * [ ` reports_tables_repack_timer ` ] ( #-pe_databases--pg_repack--reports_tables_repack_timer )
152
+ * [ ` resource_events_tables_repack_timer ` ] ( #-pe_databases--pg_repack--resource_events_tables_repack_timer )
153
+
154
+ ##### <a name =" -pe_databases--pg_repack--fact_tables " ></a >` fact_tables `
155
+
156
+ Data type: ` Array `
157
+
158
+ Array of 'fact' tables to repack
159
+
160
+ ##### <a name =" -pe_databases--pg_repack--catalog_tables " ></a >` catalog_tables `
161
+
162
+ Data type: ` Array `
163
+
164
+ Array of 'catalog' tables to repack
165
+
166
+ ##### <a name =" -pe_databases--pg_repack--other_tables " ></a >` other_tables `
147
167
148
- ##### <a name =" disable_maintenance " ></a >` disable_maintenance `
168
+ Data type: ` Array `
169
+
170
+ Array of 'other' tables to repack
171
+
172
+ ##### <a name =" -pe_databases--pg_repack--activity_tables " ></a >` activity_tables `
173
+
174
+ Data type: ` Array `
175
+
176
+ Array of 'activity' tables to repack
177
+
178
+ ##### <a name =" -pe_databases--pg_repack--disable_maintenance " ></a >` disable_maintenance `
149
179
150
180
Data type: ` Boolean `
151
181
152
182
true or false (Default: false)
153
183
Disable or enable maintenance mode
154
184
155
- Default value: `` false ` `
185
+ Default value: ` false `
156
186
157
- ##### <a name =" jobs " ></a >` jobs `
187
+ ##### <a name =" -pe_databases--pg_repack-- jobs" ></a >` jobs `
158
188
159
189
Data type: ` Integer `
160
190
161
191
How many jobs to run in parallel
162
192
163
- Default value: ` / `
193
+ Default value: ` $facts['processors']['count'] / 4 `
164
194
165
- ##### <a name =" facts_tables_repack_timer " ></a >` facts_tables_repack_timer `
195
+ ##### <a name =" -pe_databases--pg_repack-- facts_tables_repack_timer" ></a >` facts_tables_repack_timer `
166
196
167
197
Data type: ` String[1] `
168
198
169
199
The Systemd timer for the pg_repack job affecting the 'facts' tables
170
200
171
201
Default value: ` $pe_databases::facts_tables_repack_timer `
172
202
173
- ##### <a name =" catalogs_tables_repack_timer " ></a >` catalogs_tables_repack_timer `
203
+ ##### <a name =" -pe_databases--pg_repack-- catalogs_tables_repack_timer" ></a >` catalogs_tables_repack_timer `
174
204
175
205
Data type: ` String[1] `
176
206
177
207
The Systemd timer for the pg_repack job affecting the 'catalog' tables
178
208
179
209
Default value: ` $pe_databases::catalogs_tables_repack_timer `
180
210
181
- ##### <a name =" other_tables_repack_timer " ></a >` other_tables_repack_timer `
211
+ ##### <a name =" -pe_databases--pg_repack-- other_tables_repack_timer" ></a >` other_tables_repack_timer `
182
212
183
213
Data type: ` String[1] `
184
214
185
215
The Systemd timer for the pg_repack job affecting the 'other' tables
186
216
187
217
Default value: ` $pe_databases::other_tables_repack_timer `
188
218
189
- ##### <a name =" reports_tables_repack_timer " ></a >` reports_tables_repack_timer `
190
-
191
- Data type: ` Optional[String] `
219
+ ##### <a name =" -pe_databases--pg_repack--activity_tables_repack_timer " ></a >` activity_tables_repack_timer `
192
220
221
+ Data type: ` String[1] `
193
222
223
+ The Systemd timer for the pg_repack job affecting the 'activity' tables
194
224
195
- Default value: `` undef ` `
225
+ Default value: ` $pe_databases::activity_tables_repack_timer `
196
226
197
- ##### <a name =" resource_events_tables_repack_timer " ></a >` resource_events_tables_repack_timer `
227
+ ##### <a name =" -pe_databases--pg_repack--reports_tables_repack_timer " ></a >` reports_tables_repack_timer `
198
228
199
229
Data type: ` Optional[String] `
200
230
231
+ Deprecated Parameter will be removed in future releases
201
232
233
+ Default value: ` undef `
202
234
203
- Default value: `` undef ``
235
+ ##### <a name =" -pe_databases--pg_repack--resource_events_tables_repack_timer " ></a >` resource_events_tables_repack_timer `
236
+
237
+ Data type: ` Optional[String] `
238
+
239
+ Deprecated Parameter will be removed in future releases
240
+
241
+ Default value: ` undef `
204
242
205
243
## Defined types
206
244
207
- ### <a name =" pe_databasescollect " ></a >` pe_databases::collect `
245
+ ### <a name =" pe_databases--collect " ></a >` pe_databases::collect `
208
246
209
247
Create systemd units for repacking a given database type
210
248
211
249
#### Parameters
212
250
213
251
The following parameters are available in the ` pe_databases::collect ` defined type:
214
252
215
- * [ ` database_type ` ] ( #database_type )
216
- * [ ` command ` ] ( #command )
217
- * [ ` disable_maintenance ` ] ( #disable_maintenance )
218
- * [ ` on_cal ` ] ( #on_cal )
253
+ * [ ` database_type ` ] ( #-pe_databases--collect--database_type )
254
+ * [ ` command ` ] ( #-pe_databases--collect--command )
255
+ * [ ` disable_maintenance ` ] ( #-pe_databases--collect--disable_maintenance )
256
+ * [ ` on_cal ` ] ( #-pe_databases--collect--on_cal )
257
+ * [ ` tables ` ] ( #-pe_databases--collect--tables )
219
258
220
- ##### <a name =" database_type " ></a >` database_type `
259
+ ##### <a name =" -pe_databases--collect-- database_type" ></a >` database_type `
221
260
222
261
Data type: ` String `
223
262
224
263
The database to repack, uses titles from pg_repack.pp
225
264
226
265
Default value: ` $title `
227
266
228
- ##### <a name =" command " ></a >` command `
267
+ ##### <a name =" -pe_databases--collect-- command" ></a >` command `
229
268
230
269
Data type: ` String `
231
270
232
271
defined in pg_repack.pp
233
272
234
- Default value: `` undef ` `
273
+ Default value: ` undef `
235
274
236
- ##### <a name =" disable_maintenance " ></a >` disable_maintenance `
275
+ ##### <a name =" -pe_databases--collect-- disable_maintenance" ></a >` disable_maintenance `
237
276
238
277
Data type: ` Boolean `
239
278
240
279
to disable maintenance mode (Default: false)
241
280
242
- Default value: `` false ` `
281
+ Default value: ` false `
243
282
244
- ##### <a name =" on_cal " ></a >` on_cal `
283
+ ##### <a name =" -pe_databases--collect-- on_cal" ></a >` on_cal `
245
284
246
285
Data type: ` String `
247
286
248
287
values can be found in pg_repack.pp
249
288
250
- Default value: `` undef ``
289
+ Default value: ` undef `
290
+
291
+ ##### <a name =" -pe_databases--collect--tables " ></a >` tables `
292
+
293
+ Data type: ` Array `
294
+
295
+ Array of tables to repack
296
+
297
+ Default value: ` undef `
251
298
252
299
## Tasks
253
300
0 commit comments