Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.4.0 < 5.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'fvoges-pe_backup', '1.0.2'
Learn more about managing modules with a PuppetfileDocumentation
Puppet pe_backup Module
Table of Contents
Overview
pe_backup
is a minimal implementation of a Puppet Enterprise backup. It only takes a backup of the directories recommended by the documentation.
This module doesn't backup the databases, you might want to check npwalker/pe_databases for that.
Module Description
The module manages two resources, a backup script and a cron job to run the script.
This release doesn't include a restore script. To do a restore, just follow the instructions from the documentation.
Setup
What pe_backup affects
Using the default settings, pe_backup
will install a backup script /usr/local/bin/pe_backup.sh
and add a cron job to run that script every day at 3:33am.
Beginning with pe_backup
The module should work without changing any of the default parameters and only requires specifying the destination for the backup using the destination
parameter.
NOTE: the module expects the destination directory to exist. It will not try to create it. It's better to manage that from a profile instead of trying to work out all the possible cases inside this module.
Usage
Getting started
The basic use case requires passing the destination directory to the pe_backup
class:
class { 'pe_backup':
destination => '/vol/backups/pe_backups',
}
The first time that that code is applied to a node, it will create the backup script /urs/local/bin/pe_backup.sh
and a cron job for the root
user to run it every day at 3:33am.
The backups will be stored in the location specified with the destination
parameter using the naming pe_backup-YYYYMMDDHHMM.tar.bz2
. Where pe_backup
is the default prefix and YYYYMMDDHHMM
is the current time stamp at the time the script was executed.
Specify a file name prefix for the backup
By default, the backups created will use the default prefix (pe_backup
). The prefix can be altered to use something else by specifying the prefix
parameter.
The following example uses the trusted fact certname
as the file prefix.
class { '::pe_backup':
destination => $destination,
prefix => $::trusted['certname'],
}
Specify extra directory to backup
Example profile working together with npwalker/pe_databases.
This example uses the
# Profile profile::puppet::backup
class profile::puppet::backup {
$destination = hiera('profile::puppet::backup::destination')
include ::pe_databases::backup
file { $destination:
ensure => directory,
owner => 'root',
group => 'root',
mode => '0750',
}
class { '::pe_backup':
destination => $destination,
prefix => $::trusted['certname'],
# include the database dumps fron pe_databases::backup too
dirs_extra => [ $pe_databases::backup::backup_directory, ],
}
}
Reference
Classes
Public Classes
pe_backup
: Installs and configures the PE backup script
Private Classes
pe_backup::install
: Installs the scriptpe_backup::service
: Manages the cronjob
Parameters
pe_backup
destination
(Stdlib::Absolutepath
)
Destination directory for the backups.
Valid values are any valid UNIX absolute path.
Mandatory.
user
(String
)
Backup script owner user.
Defaults to root
.
group
(String
)
Backup script owner group.
Defaults to root
.
umask
(String
)
Sets the umask
inside the backup script.
Defaults to 0077
.
prefix
(String
)
Backup file name prefix.
Defaults to pe_backup
.
script
(Stdlib::Absolutepath
)
Backup script name including absolute path.
Valid values are any valid UNIX absolute path including file name.
Defaults to /usr/local/bin/pe_backup.sh
.
hour
(String
)
Crontab hour for the backup.
Valid values are the ones for the cron type.
Defaults to 3
.
minute
(String
)
Crontab minute for the backup.
Valid values are the ones for the cron type.
Defaults to 33
.
weekday
(String
)
Crontab weekday for the backup.
Valid values are the ones for the cron type.
Defaults to *
(everyday).
nodetype
(Enum
)
Puppet node type. Allows to customize the backed up directories based for different types of Puppet servers (Master, PuppetDB, Console, etc.).
Valid values are monolithic
, master
, db
, or console
.
Defaults to monolithic
.
dirs_common
(Array
)
List of directories that need to be backed up on all node types. This shouldn't need changing in most cases.
Valid values are any Array
containing a list of absolute paths. Use dirs_extra
to specify additional directories.
Defaults to '/etc/puppetlabs'.
dirs_master
(Array
)
List of directories that need to be backed up on a Puppet Master node. This shouldn't need changing in most cases. Use dirs_extra
to specify additional directories.
Valid values are any Array
containing a list of absolute paths.
Defaults to []
(empty array).
dirs_db
(Array
)
List of directories that need to be backed up on a PuppetDB node. This shouldn't need changing in most cases. Use dirs_extra
to specify additional directories.
Valid values are any Array
containing a list of absolute paths.
Defaults to [ '/opt/puppetlabs/server/data/postgresql/9.4/data/certs', ]
.
dirs_console
(Array
)
List of directories that need to be backed up on a Puppet Console node. This shouldn't need changing in most cases. Use dirs_extra
to specify additional directories.
Valid values are any Array
containing a list of absolute paths.
Defaults to [ '/opt/puppetlabs/server/data/console-services/certs', ]
.
dirs_extra
(Array
)
List of additional directories that need to be backed up on a node. Most likely to be used to backup the database dumps.
Valid values are any Array
containing a list of absolute paths.
Defaults to []
(empty array).
Limitations
- No restore functionality yet.
- Work around: Use the manual steps from the documentation
- No ability to set the backup retention policy. yet.
- Work around: Use a cron job to delete the old backups.
- The script doesn't check to see if another backup is in progress.
Development
Feel free to send bug reports and pull requests to the project page.
1.0.2 / 2017-04-18
- [issue #2] Improve documentation
1.0.1 / 2017-04-18
- add example profile to README
- change template to use $prefix instead of hardcoded value
- remove unnecessary file
1.0.0 / 2017-04-18
- Initial release
Dependencies
- puppetlabs-stdlib (>= 4.13.0 < 5.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.