Skip to content

(SUP-2677) Deprecate backup functionality #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ It is not recommended to classify using a pre-existing node group in the PE Cons

### Backup Schedule

> WARNING: The backup functionality in this module has been deprecated and will be removed in a future release.
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.
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.
You should also clean up associated crontab entries.

Backups are not activated by default but can be enabled by setting the following parameter:

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

## Backups

> WARNING: The backup functionality in this module has been deprecated and will be removed in a future release.
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.
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.
You should also clean up associated crontab entries.

This is the documentation for Pupet Enterprise backups:

https://puppet.com/docs/pe/latest/backing_up_and_restoring_pe.html
Expand Down
4 changes: 4 additions & 0 deletions manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@
class { 'pe_databases::backup':
disable_maintenance => ! $manage_database_backups,
}
notify { 'pe_databases_backup_deprecate_warn':
message => 'The backup functionality in the pe_databases module has been deprecated and will be removed in a future release',
loglevel => warning,
}
}
}
else {
Expand Down
5 changes: 3 additions & 2 deletions spec/acceptance/backup_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ class { 'pe_databases':
}#{' '}
MANIFEST

# Run it twice and test for idempotency
idempotent_apply(pp)
# Expect a change due to backup notify
apply_manifest(pp)
apply_manifest(pp, expect_changes: true)
end
end