77### Classes
88
99* [ ` 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
1111
1212### Defined types
1313
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
1515
1616### Tasks
1717
@@ -27,227 +27,274 @@ Tuning, maintenance for PE PostgreSQL.
2727
2828The following parameters are available in the ` pe_databases ` class:
2929
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 `
4344
4445Data type: ` Boolean `
4546
4647true or false (Default: true)
4748Manage the inclusion of the pg_repack class
4849
49- Default value: `` true ` `
50+ Default value: ` true `
5051
51- ##### <a name =" disable_maintenance " ></a >` disable_maintenance `
52+ ##### <a name =" -pe_databases-- disable_maintenance" ></a >` disable_maintenance `
5253
5354Data type: ` Boolean `
5455
5556true or false (Default: false)
5657Disable or enable maintenance mode
5758
58- Default value: `` false ` `
59+ Default value: ` false `
5960
60- ##### <a name =" install_dir " ></a >` install_dir `
61+ ##### <a name =" -pe_databases-- install_dir" ></a >` install_dir `
6162
6263Data type: ` String[1] `
6364
6465Directory to install module into (Default: "/opt/puppetlabs/pe_databases")
6566
6667Default value: ` '/opt/puppetlabs/pe_databases' `
6768
68- ##### <a name =" scripts_dir " ></a >` scripts_dir `
69+ ##### <a name =" -pe_databases-- scripts_dir" ></a >` scripts_dir `
6970
7071Data type: ` String[1] `
7172
7273Directory to install scripts into (Default: "${install_dir}/scripts")
7374
7475Default value: ` "${install_dir}/scripts" `
7576
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 `
7778
7879Data type: ` String[1] `
7980
8081The Systemd timer for the pg_repack job affecting the 'facts' tables
8182
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 `
8584
8685Data type: ` String[1] `
8786
8887The Systemd timer for the pg_repack job affecting the 'catalog' tables
8988
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 `
9390
9491Data type: ` String[1] `
9592
9693The Systemd timer for the pg_repack job affecting the 'other' tables
9794
98- Default value: ` '*-*-20 05:30:00' `
95+ ##### < a name = " -pe_databases--activity_tables_repack_timer " ></ a > ` activity_tables_repack_timer `
9996
100- ##### < a name = " manage_postgresql_settings " ></ a > ` manage_postgresql_settings `
97+ Data type: ` String[1] `
10198
102- Data type: ` Optional[Boolean] `
99+ The Systemd timer for the pg_repack job affecting the 'activity' tables
103100
101+ ##### <a name =" -pe_databases--manage_postgresql_settings " ></a >` manage_postgresql_settings `
104102
103+ Data type: ` Optional[Boolean] `
105104
106- Default value: `` undef ``
105+ Deprecated Parameter will be removed in future releases
107106
108- ##### < a name = " manage_table_settings " ></ a > ` manage_table_settings `
107+ Default value: ` undef `
109108
110- Data type: ` Optional[Boolean] `
109+ ##### < a name = " -pe_databases--manage_table_settings " ></ a > ` manage_table_settings `
111110
111+ Data type: ` Optional[Boolean] `
112112
113+ Deprecated Parameter will be removed in future releases
113114
114- Default value: `` undef ` `
115+ Default value: ` undef `
115116
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 `
117118
118119Data type: ` Optional[String] `
119120
121+ Deprecated Parameter will be removed in future releases
120122
123+ Default value: ` undef `
121124
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 `
125126
126127Data type: ` Optional[String] `
127128
129+ Deprecated Parameter will be removed in future releases
128130
131+ Default value: ` undef `
129132
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 `
133134
134135Maintenance pg_repack
135136
136137#### Parameters
137138
138139The following parameters are available in the ` pe_databases::pg_repack ` class:
139140
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 `
147167
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 `
149179
150180Data type: ` Boolean `
151181
152182true or false (Default: false)
153183Disable or enable maintenance mode
154184
155- Default value: `` false ` `
185+ Default value: ` false `
156186
157- ##### <a name =" jobs " ></a >` jobs `
187+ ##### <a name =" -pe_databases--pg_repack-- jobs" ></a >` jobs `
158188
159189Data type: ` Integer `
160190
161191How many jobs to run in parallel
162192
163- Default value: ` / `
193+ Default value: ` $facts['processors']['count'] / 4 `
164194
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 `
166196
167197Data type: ` String[1] `
168198
169199The Systemd timer for the pg_repack job affecting the 'facts' tables
170200
171201Default value: ` $pe_databases::facts_tables_repack_timer `
172202
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 `
174204
175205Data type: ` String[1] `
176206
177207The Systemd timer for the pg_repack job affecting the 'catalog' tables
178208
179209Default value: ` $pe_databases::catalogs_tables_repack_timer `
180210
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 `
182212
183213Data type: ` String[1] `
184214
185215The Systemd timer for the pg_repack job affecting the 'other' tables
186216
187217Default value: ` $pe_databases::other_tables_repack_timer `
188218
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 `
192220
221+ Data type: ` String[1] `
193222
223+ The Systemd timer for the pg_repack job affecting the 'activity' tables
194224
195- Default value: `` undef ` `
225+ Default value: ` $pe_databases::activity_tables_repack_timer `
196226
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 `
198228
199229Data type: ` Optional[String] `
200230
231+ Deprecated Parameter will be removed in future releases
201232
233+ Default value: ` undef `
202234
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 `
204242
205243## Defined types
206244
207- ### <a name =" pe_databasescollect " ></a >` pe_databases::collect `
245+ ### <a name =" pe_databases--collect " ></a >` pe_databases::collect `
208246
209247Create systemd units for repacking a given database type
210248
211249#### Parameters
212250
213251The following parameters are available in the ` pe_databases::collect ` defined type:
214252
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 )
219258
220- ##### <a name =" database_type " ></a >` database_type `
259+ ##### <a name =" -pe_databases--collect-- database_type" ></a >` database_type `
221260
222261Data type: ` String `
223262
224263The database to repack, uses titles from pg_repack.pp
225264
226265Default value: ` $title `
227266
228- ##### <a name =" command " ></a >` command `
267+ ##### <a name =" -pe_databases--collect-- command" ></a >` command `
229268
230269Data type: ` String `
231270
232271defined in pg_repack.pp
233272
234- Default value: `` undef ` `
273+ Default value: ` undef `
235274
236- ##### <a name =" disable_maintenance " ></a >` disable_maintenance `
275+ ##### <a name =" -pe_databases--collect-- disable_maintenance" ></a >` disable_maintenance `
237276
238277Data type: ` Boolean `
239278
240279to disable maintenance mode (Default: false)
241280
242- Default value: `` false ` `
281+ Default value: ` false `
243282
244- ##### <a name =" on_cal " ></a >` on_cal `
283+ ##### <a name =" -pe_databases--collect-- on_cal" ></a >` on_cal `
245284
246285Data type: ` String `
247286
248287values can be found in pg_repack.pp
249288
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 `
251298
252299## Tasks
253300
0 commit comments