Version information
This version is compatible with:
- Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 3.2.0 < 5.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'nexcess-r1soft', '2.0.0'
Learn more about managing modules with a PuppetfileDocumentation
r1soft
Table of Contents
- Overview
- Module Description
- Usage - Configuration options and additional functionality
- Reference
- Limitations
- Development
- Copyright
Overview
This module installs and configures the r1soft backup agent and the r1soft backup server.
Module Description
This module installs and configures the r1soft backup agent and the r1soft backup server.
For the agent, it will install the r1soft yum repository, the kernel-devel pacakge, the cdp kernel module, install keys for r1soft backup servers, and start the r1soft agent.
For the server, it will install the r1soft yum repository, manage the admin + password, manage the http and https port, and manage the max-memory setting.
Usage
Beginning with r1soft::agent
To install the r1soft agent with keys for 198.51.100.2 and 198.51.100.3, and ensuring a key is absent for 198.51.100.4:
class {'::r1soft::agent':
keys => {'198.51.100.2' => {key => "-----BEGIN PUBLIC KEY-----\nDEADBEEF\n-----END PUBLIC KEY-----",},
'198.51.100.3' => {key => "-----BEGIN PUBLIC KEY-----\nCAFEFOOD\n-----END PUBLIC KEY-----",},
'198.51.100.4' => {ensure => 'absent'}}
}
It looks much better and is much easier to manage in hiera:
# in hiera.yaml
r1soft::agent::keys:
198.51.100.2:
key: |
-----BEGIN PUBLIC KEY-----
DEADBEEFDEADBEEFDEADBEEFDEADBEEFDEADBEEF
FBADBEEFFBADBEEFFBADBEEFFBADBEEFFBADBEEF
BADDCAFEBADDCAFEBADDCAFEBADDCAFEBADDCAFE
-----END PUBLIC KEY-----
198.51.100.3:
key: |
-----BEGIN PUBLIC KEY-----
CAFEFOODCAFEFOODCAFEFOODCAFEFOODCAFEFOOD
B105F00DB105F00DB105F00DB105F00DB105F00D
C00010FFC00010FFC00010FFC00010FFC00010FF
-----END PUBLIC KEY-----
198.51.100.4:
ensure: absent
# in your manifest.pp
class {'::r1soft::agent':}
Beginning with r1soft::server
To install the r1soft server with the password 'insecure':
class {'::r1soft::server':
admin_pass => 'insecure',
}
Reference
r1soft::agent parameters
repo_install
Specify if you want the module to install the r1soft repository. Default value: true
package_version
Specify the version of r1soft agent to install. Default value: 'present'
package_name
Specify the name of the r1soft agent package. Default value: 'serverbackup-agent'
kernel_devel_install
Specify if you want the module to install the kernel-devel package which is needed by r1soft agent. Default value: true
kernel_devel_package_names
Specify the kernel-devel package name. Default value: kernel-devel-${::kernelrelease}
service_manage
Specify if you want to the module to manage the r1soft agent service. Default value: true
service_name
Specify the name of the r1soft agent service. Default value: 'cdp-agent'
service_ensure
Specify the ensure value of the r1soft agent service. Default value: 'running'
service_enable
Specify the enable value of the r1soft agent service. Default value: true
keys
Specify a list of keys to place on the r1soft agent server. Default value: empty
keys_purge_unmanaged
Specify if you want to purge all keys not managed by puppet: Default value: false
r1soft::server parameters
repo_install
Specify if you want the module to install the r1soft repository. Default value: true
package_version
Specify the version of r1soft server to install. Default value: 'present'
package_name
Specify the name of the r1soft server package. Default value: 'serverbackup-agent'
service_manage
Specify if you want to the module to manage the r1soft server service. Default value: true
service_name
Specify the name of the r1soft server service. Default value: 'cdp-agent'
service_ensure
Specify the ensure value of the r1soft server service. Default value: 'running'
service_enable
Specify the enable value of the r1soft server service. Default value: true
admin_user
Specify the admin user name. Default value: 'admin'
admin_pass
Specify the admin user password. This needs to be set for r1soft server to work Default value: false
max_mem
Specify max_mem for r1soft server. Default value: undef
http_port
Specify http port for r1soft server. Default value: 80
https_port
Specify https port for r1soft server. Default value: 443
r1osft::repo parameters
repo_baseurl
Specify the baseurl for the yum repo. Default value: 'http://repo.r1soft.com/yum/stable/$basearch/'
http is used instead of https because r1soft doesn't include the full chain for their certificate. CentOS has the root certificate but not the intermediate certificate. It is web server's responsibility to send intermediate certificates. Without the intermediate certificate, the TLS connection and yum fail. See [ssllabs's test](https://www.ssllabs.com/ssltest/analyze.html?d=repo.r1soft.com for more info.
repo_enabled
Specify the enable value for the yum repo. Default value: true
repo_gpgcheck
Specify the gpgcheck value for the yum repo. Default value: false
r1soft does not sign their RPMs. We have already opened a ticket with them about it.
Facts
r1soft_agent_version
: r1soft version and build number. eg5.12.0-21
r1soft_agent_version_short
: r1soft version number. eg5.12.0
r1soft_agent_version_long
: r1soft version number, build number, and build date. eg5.12.0 build 21 2015/08/26 20:31:22
Development
Install necessary gems:
bundle install --path vendor/bundle
Check syntax of all puppet manifests, erb templates, and ruby files:
bundle exec rake validate
Run puppetlint on all puppet files:
bundle exec rake lint
Run spec tests in a clean fixtures directory
bundle exec rake spec
Run acceptance tests:
BEAKER_set=centos-7-x64 bundle exec rake acceptance
Copyright
Copyright 2015 Nexcess
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.
2.0.0 - 2016-08-20
- the managemnt of the r1sfot repo repo is a separate class now. it can still be installed through the agent.
- the following parameters were moved from r1soft::agent to r1soft::repo:
- repo_baseurl
- repo_enabled
- repo_gpgcheck
- the following parameters were renamed in r1soft::agent:
- cdp_agent_package_version -> package_version
- cdp_agent_package_name -> package_name
- added r1soft::server class
- added testing with beaker and travis
1.0.0 - 2015-12-13
- initial release
Dependencies
- puppetlabs-stdlib (>= 2.0.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.