Skip to content

Commit 48cdff6

Browse files
Merge pull request #96 from elainemccloskey/deprecate_backup
(SUP-2677) Deprecate backup functionality
2 parents 22a7307 + 713ee64 commit 48cdff6

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ It is not recommended to classify using a pre-existing node group in the PE Cons
4848

4949
### Backup Schedule
5050

51+
> WARNING: The backup functionality in this module has been deprecated and will be removed in a future release.
52+
Please refer to the [PE Backup and Restore documentation](https://puppet.com/docs/pe/latest/backing_up_and_restoring_pe.html) for details on how to backup.
53+
You should ensure the parameter `pe_databases::manage_database_backups` and any parameters from the `pe_databases::backup` class are removed from classification or hiera.
54+
You should also clean up associated crontab entries.
55+
5156
Backups are not activated by default but can be enabled by setting the following parameter:
5257

5358
Hiera classification example
@@ -90,6 +95,11 @@ Those defaults change based on the `$all_in_one_pe` parameter.
9095

9196
## Backups
9297

98+
> WARNING: The backup functionality in this module has been deprecated and will be removed in a future release.
99+
Please refer to the [PE Backup and Restore documentation](https://puppet.com/docs/pe/latest/backing_up_and_restoring_pe.html) for details on how to backup.
100+
You should ensure the parameter `pe_databases::manage_database_backups` and any parameters from the `pe_databases::backup` class are removed from classification or hiera.
101+
You should also clean up associated crontab entries.
102+
93103
This is the documentation for Pupet Enterprise backups:
94104

95105
https://puppet.com/docs/pe/latest/backing_up_and_restoring_pe.html

manifests/init.pp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@
4949
class { 'pe_databases::backup':
5050
disable_maintenance => ! $manage_database_backups,
5151
}
52+
notify { 'pe_databases_backup_deprecate_warn':
53+
message => 'The backup functionality in the pe_databases module has been deprecated and will be removed in a future release',
54+
loglevel => warning,
55+
}
5256
}
5357
}
5458
else {

spec/acceptance/backup_spec.rb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ class { 'pe_databases':
88
}#{' '}
99
MANIFEST
1010

11-
# Run it twice and test for idempotency
12-
idempotent_apply(pp)
11+
# Expect a change due to backup notify
12+
apply_manifest(pp)
13+
apply_manifest(pp, expect_changes: true)
1314
end
1415
end

0 commit comments

Comments
 (0)