Skip to content

Commit b9aa277

Browse files
committed
SVCPLAN-5040: Only send CRON emails on error
1 parent bbff1de commit b9aa277

File tree

2 files changed

+46
-65
lines changed

2 files changed

+46
-65
lines changed

REFERENCE.md

Lines changed: 44 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
### Defined types
1515

16+
* [`profile_backup::client::add_cmd_job`](#profile_backup--client--add_cmd_job)
1617
* [`profile_backup::client::add_job`](#profile_backup--client--add_job): Defined type to add a new service backup job
17-
* [`profile_backup::client::add_cmd_job`](#profile_backup--client--add_cmd_job): Defined type to add a new service cmd backup job
1818
* [`profile_backup::server::allow_client`](#profile_backup--server--allow_client): Enable backup client to access backup server
1919

2020
## Classes
@@ -261,110 +261,91 @@ Username that owns backup files and allowed access.
261261

262262
## Defined types
263263

264-
### <a name="profile_backup--client--add_job"></a>`profile_backup::client::add_job`
264+
### <a name="profile_backup--client--add_cmd_job"></a>`profile_backup::client::add_cmd_job`
265265

266-
Add a service backup job to this backup client
266+
The profile_backup::client::add_cmd_job class.
267267

268-
#### Examples
268+
#### Parameters
269269

270-
#####
270+
The following parameters are available in the `profile_backup::client::add_cmd_job` defined type:
271271

272-
```puppet
273-
profile_backup::client::add_job { 'jobname':
274-
paths => [ '/directory1', '/tmp/directory2.tar', ],
275-
prehook_commands => 'tar cf /tmp/directory2.tar /directory2',
276-
posthook_commands => 'rm -f /tmp/directory2.tar',
277-
}
278-
```
272+
* [`backup_command`](#-profile_backup--client--add_cmd_job--backup_command)
273+
* [`filename`](#-profile_backup--client--add_cmd_job--filename)
274+
* [`prehook_commands`](#-profile_backup--client--add_cmd_job--prehook_commands)
275+
* [`posthook_commands`](#-profile_backup--client--add_cmd_job--posthook_commands)
279276

280-
### <a name="profile_backup--client--add_cmd_job"></a>`profile_backup::client::add_cmd_job`
277+
##### <a name="-profile_backup--client--add_cmd_job--backup_command"></a>`backup_command`
281278

282-
Add a service backup job to this backup client
279+
Data type: `String`
283280

284-
Add a service cmd backup job to this backup client
285-
This allows the streaming of data (STDOUT) directly to
286-
the backup without staging data to a file first. An example
287-
for the use would be to eliminate the need for a large database
288-
to be stored locally before being backed up.
289281

290282

291-
#### Examples
283+
##### <a name="-profile_backup--client--add_cmd_job--filename"></a>`filename`
292284

293-
#####
285+
Data type: `String`
294286

295-
```puppet
296-
profile_backup::client::add_cmd_job { 'jobname':
297-
backup_command => 'mysqldump --single-transaction mydatabase',
298-
filename => 'mydatabase.dump',
299-
prehook_commands => 'tar cf /tmp/directory2.tar /directory2',
300-
posthook_commands => 'rm -f /tmp/directory2.tar',
301-
}
302-
```
303287

304288

305-
#### Parameters
289+
##### <a name="-profile_backup--client--add_cmd_job--prehook_commands"></a>`prehook_commands`
306290

307-
The following parameters are available in the `profile_backup::client::add_job` defined type:
291+
Data type: `Optional[Array[String]]`
308292

309-
* [`paths`](#-profile_backup--client--add_job--paths)
310-
* [`prehook_commands`](#-profile_backup--client--add_job--prehook_commands)
311-
* [`posthook_commands`](#-profile_backup--client--add_job--posthook_commands)
312293

313-
##### <a name="-profile_backup--client--add_job--paths"></a>`paths`
314294

315-
Data type: `Array[String]`
295+
Default value: `undef`
316296

317-
List of directory paths for the job to backup.
318-
Can be a list of directories and/or specific files.
297+
##### <a name="-profile_backup--client--add_cmd_job--posthook_commands"></a>`posthook_commands`
319298

320-
##### <a name="-profile_backup--client--add_job--prehook_commands"></a>`prehook_commands`
299+
Data type: `Optional[Array[String]]`
321300

322-
Data type: `Optional[String]`
323301

324-
Optional commands to run before backup job
325302

326303
Default value: `undef`
327304

328-
##### <a name="-profile_backup--client--add_job--posthook_commands"></a>`posthook_commands`
329-
330-
Data type: `Optional[String]`
305+
### <a name="profile_backup--client--add_job"></a>`profile_backup::client::add_job`
331306

332-
Optional commands to run after the backup job
307+
Add a service backup job to this backup client
333308

334-
Default value: `undef`
309+
#### Examples
335310

336-
The following parameters are available in the `profile_backup::client::add_cmd_job` defined type:
311+
#####
337312

338-
* [`command`](#-profile_backup--client--add_cmd_job--command)
339-
* [`filename`](#-profile_backup--client--add_cmd_job--filename)
340-
* [`prehook_commands`](#-profile_backup--client--add_job--prehook_commands)
341-
* [`posthook_commands`](#-profile_backup--client--add_job--posthook_commands)
313+
```puppet
314+
profile_backup::client::add_job { 'jobname':
315+
paths => [ '/directory1', '/tmp/directory2.tar', ],
316+
prehook_commands => [ 'tar cf /tmp/directory2.tar /directory2', ],
317+
posthook_commands => [ 'rm -f /tmp/directory2.tar', ],
318+
}
319+
```
342320

343-
##### <a name="-profile_backup--client--add_cmd_job--command"></a>`paths`
321+
#### Parameters
344322

345-
Data type: `String`
323+
The following parameters are available in the `profile_backup::client::add_job` defined type:
346324

347-
Command to be ran in which the STDOUT is captured and backed up
325+
* [`paths`](#-profile_backup--client--add_job--paths)
326+
* [`prehook_commands`](#-profile_backup--client--add_job--prehook_commands)
327+
* [`posthook_commands`](#-profile_backup--client--add_job--posthook_commands)
348328

349-
##### <a name="-profile_backup--client--add_cmd_job--command"></a>`paths`
329+
##### <a name="-profile_backup--client--add_job--paths"></a>`paths`
350330

351-
Data type: `String`
331+
Data type: `Array[String]`
352332

353-
Name of the file within the archive to store the data from the command
333+
List of directory paths for the job to backup.
334+
Can be a list of directories and/or specific files.
354335

355-
##### <a name="-profile_backup--client--add_cmd_job--prehook_commands"></a>`prehook_commands`
336+
##### <a name="-profile_backup--client--add_job--prehook_commands"></a>`prehook_commands`
356337

357-
Data type: `Optional[String]`
338+
Data type: `Optional[Array[String]]`
358339

359-
Optional commands to run before cmd backup job
340+
Optional list of commands to run before backup job
360341

361342
Default value: `undef`
362343

363-
##### <a name="-profile_backup--client--add_cmd_job--posthook_commands"></a>`posthook_commands`
344+
##### <a name="-profile_backup--client--add_job--posthook_commands"></a>`posthook_commands`
364345

365-
Data type: `Optional[String]`
346+
Data type: `Optional[Array[String]]`
366347

367-
Optional commands to run after the cmd backup job
348+
Optional list of commands to run after the backup job
368349

369350
Default value: `undef`
370351

manifests/client.pp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,13 +180,13 @@
180180

181181
cron { 'profile_backup verify':
182182
ensure => $cron_ensure,
183-
command => "${work_directory}/cron_check_backup.sh",
183+
command => "${work_directory}/cron_check_backup.sh > /dev/null 2>&1 || ( echo BACKUP VERIFY ERROR ; cat /var/log/backup_check_last_run )",
184184
* => $verify_cron_schedule,
185185
}
186186

187187
cron { 'profile_backup backup jobs':
188188
ensure => $cron_ensure,
189-
command => "${work_directory}/cron_do_backup.sh",
189+
command => "${work_directory}/cron_do_backup.sh > /dev/null 2>&1 || ( echo BACKUP JOBS ERROR ; cat /var/log/backup_last_run )",
190190
* => $job_cron_schedule,
191191
}
192192
}

0 commit comments

Comments
 (0)