Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-augeasproviders_core', '4.1.0'
Learn more about managing modules with a PuppetfileDocumentation
augeasproviders_core: library for building alternative Augeas-based providers for Puppet
Module description
This module provides a library for module authors to create new types and providers around config files, using the Augeas configuration library to read and modify them.
The advantage of using Augeas over the default Puppet parsedfile
implementations is that Augeas will go to great lengths to preserve file
formatting and comments, while also failing safely when needed.
If you're a user, you want to see the main augeasproviders project at augeasproviders.com.
Requirements
Ensure both Augeas and ruby-augeas 0.3.0+ bindings are installed and working as normal.
See Puppet/Augeas pre-requisites.
Development documentation
See docs/ (run make
) or augeasproviders.com.
Issues
Please file any issues or suggestions on GitHub.
Transfer Notice
This plugin was originally authored by hercules-team. The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp.
Previously: https://github.com/hercules-team/augeasproviders_core
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v4.1.0 (2023-10-30)
Implemented enhancements:
- Add Ubuntu 22.04 support #62 (bastelfreak)
- Add Debian 11 and 12 support #61 (bastelfreak)
v4.0.1 (2023-07-11)
Fixed bugs:
v4.0.0 (2023-06-21)
Breaking changes:
- Drop Puppet 6 support #52 (bastelfreak)
Implemented enhancements:
- Drop unneeded stdlib dependency #54 (bastelfreak)
- Add puppet 8 support #53 (bastelfreak)
- Add RHEL 9 to supported OS #46 (tuxmea)
Merged pull requests:
v3.2.1 (2023-04-26)
Fixed bugs:
Merged pull requests:
- Use expect() instead of .should #45 (ekohl)
- Fix broken Apache-2 license #44 (bastelfreak)
- rspec: Remove Puppet::Util::Storage mock #42 (lollipopman)
- Update git:// github.com submodule URL to use https:// #38 (jamespwilliams)
v3.2.0 (2022-05-06)
Closed issues:
- Wildcards in default_file block #8
Merged pull requests:
- Cleanup metadata.json/README.md #36 (bastelfreak)
3.1.0 (2021-08-26)
- Allow stdlib 8.0.0 (GH #34)
3.0.0
- Remove empty Hiera data (GH #29)
- PDK update & lint (GH #30)
- Support Puppet 6 and 7, deprecate Puppet 5 (GH #32)
- Update supported Ubuntu versions (GH #33)
2.7.0
- Lint with Rubocop (GH #23)
- Raise Puppet::Error instead of using fail() (GH #24)
- Migrate to PDK (GH #25)
- Support stdlib 7.x (GH #26)
2.6.0
- Add array split_by option (GH #20)
- Switch to xenial for Travis CI tests (GH #22)
- Add Debian 10 and Red Hat 8 to the supported OS list (GH #21)
2.5.0
- Support puppetlabs/stdlib 6 in metadata.json
2.4.0
- Revert broken exists? implementation
- Remove support for Puppet 4
- Update supported OSes in metadata.json
2.3.0
- Support Puppet 6 (GH #11)
- Update metadata.json to reflect supported Ubuntu versions
2.1.5
- Allow puppetlabs/stdlib 5.x (GH #9)
2.1.4
- Upped supported Puppet versions to include Puppet 5
2.1.3
- Test and list compatibility with Puppet 4 and latest OSes
- Fix catalog building in spec helper under Puppet 4.6
- Various fixes to test suite and gemset
2.1.2
- Fix fixtures lib for RSpec 3
- Avoid shadowing variable
- Improve tags in README
2.1.1
- Fix metadata.json
2.1.0
- Add whichquote method
2.0.1
- Fix README.md
2.0.0
- Split core library from types and providers
1.2.0
-
API
- add next_seq method
-
Providers
- fix creation of multiple resources using seq entries under Puppet 3.4, fixes #101
- pam: obey file target or service, fixes #105
- pam: arguments default to [], fixes #100
- pam: add “control_is_param” parameter to decide whether “control” is a resource identifier or property, fixes #114
- sysctl: fix tests under latest Augeas
1.1.0
-
General
- add augeasproviders::instances class, fixes #78
- add development doc
- test actual versions of Augeas in Travis CI
- improve errors when loading and saving files
- reorganize unit tests
- workaround Puppet 3.5 type loading bug, fixes #96
-
API
- share an Augeas handler on Puppet 3.4+ for performance
- add parsed_as? method
- add aug_version method
- add supported? method
- add rm_node to accessors
-
Providers
- apache_directive: new type/provider
- pam: new type/provider
- shellvar: add unset and exported values for 'ensure'
- shellvar: add an 'uncomment' param
- shellvar: add an 'array_append' parameter
- sshd_config: support case_insensitive entries
- sshd_config: ensure that Port is inserted before ListenAddress, fixes #68
- sshd_config_subsystem: support case_insensitive entries
- do not confine providers to the existence of target files
1.0.2
- no change, re-release for bad tarball checksum
1.0.1
- sysctl: fix quoting issue when applying settings, fixes #53 (Jeremy Kitchen)
- sysctl: fix apply=>false, was always running, fixes #56 (Trey Dockendorf)
- all: use augeas/lenses/ from Puppet's pluginsync libdir (Craig Dunn)
- sshd: create array entries before Match groups
1.0.0
- devel: AugeasProviders::Provider has gained a large number of helper methods for writing providers
- all: providers completely refactored to use AugeasProviders::Provider helpers
- sysctl: ignore whitespace inside values during comparisons, fixes #50
- shellvar: fix require to work for puppet apply/specs
0.7.0
- pg_hba: new type for managing PostgreSQL pg_hba.conf entries
- shellvar: add support for array values
- sysctl: add 'apply' parameter to change live kernel value (default: true)
- sysctl: add 'val' parameter alias for duritong/puppet-sysctl compatibility
- mailalias: fix quoting of pipe recipients, fixes #41
- devel: test Ruby 2.0
0.6.1
- syslog: add rsyslog provider variant, requires Augeas 1.0.0
- all: fix ruby-augeas 0.3.0 compatibility on Ruby 1.9
- all: don't throw error when target file doesn't already exist
- kernel_parameter/grub: ensure partially present parameters will be removed
0.6.0
- apache_setenv: new type for managing Apache HTTP SetEnv config options (Endre Karlson)
- puppet_auth: new type for managing Puppet's auth.conf file
- shellvar: new type for managing /etc/{default,sysconfig}
- kernel_parameter: use EFI GRUB legacy config if present
- devel: replaced librarian-puppet with puppetlabs_spec_helper's .fixtures.yml
- devel: use augparse --notypecheck for improved speed
0.5.3
- sshd_config: reinstate separate name parameter
- docs: add sshd_config multiple keys example, fixes #27
0.5.2
- sshd_config, sysctl: create entries after commented out entry
- host, mailalias: implement prefetch for performance
- sshd_config: remove separate name parameter, only use key as namevar
- docs: remove symlinks from docs/, fixes #25, improve README, rename LICENSE
- devel: improve idempotence logging
- devel: update to Augeas 1.0.0, test Puppet 3.1
0.5.1
- all: fix library loading issue with
puppet apply
0.5.0
- kernel_parameter: new type for managing kernel arguments in GRUB Legacy and GRUB 2 configs
- docs: documentation index, existing articles and numerous examples for all providers added
- docs: URLs changed to GitHub hercules-team organisation
- devel: files existence stubbed out in tests
- devel: Augeas submodule changed to point to GitHub
- devel: specs compatibility with 2.7.20 fixed
0.4.0
- nrpe_command: new type for managing NRPE settings (Christian Kaenzig)
- syslog: new type for managing (r)syslog destinations (Raphaël Pinson)
0.3.1
- all: fix missing require causing load errors
- sshd_config: store multiple values for a setting as multiple entries, e.g. multiple ListenAddress lines (issue #13)
- docs: minor fixes
- devel: test Puppet 3.0
0.3.0
- sysctl: new type for managing sysctl.conf entries
- mounttab: add Solaris /etc/vfstab support
- mounttab: fix options property idempotency
- mounttab: fix key=value options in fstab instances
- host: fix comment and host_aliases properties idempotency
- all: log /augeas//error output when unable to save
- packaging: hard mount_providers dependency removed
- devel: augparse used to test providers against expected tree
- devel: augeas submodule included for testing against latest lenses
0.2.0
- mounttab: new provider for mounttab type in puppetlabs-mount_providers (supports fstab only, no vfstab), mount_providers now a dependency
- devel: librarian-puppet used to install Puppet module dependencies
0.1.1
- host: fix host_aliases param support pre-2.7
- sshd_config: find Match groups in instances/ralsh
- sshd_config: support arrays for ((Allow|Deny)(Groups|Users))|AcceptEnv|MACs
- sshd_config_subsystem: new type and provider (Raphaël Pinson)
- devel: use Travis CI, specify deps via Gemfile + bundler
- specs: fixes for 0.25 and 2.6 series
0.1.0
- host: fix pre-2.7 compatibility when without comment property
- sshd_config: new type and provider (Raphaël Pinson)
- all: fix provider confine to enable use in same run as ruby-augeas install (Puppet #14822)
- devel: refactor common augopen code into utility class
- specs: fix both Ruby 1.8 and mocha 0.12 compatibility
0.0.4
- host: fix handling of multiple host_aliases
- host: fix handling of empty comment string, now removes comment
- host: fix missing ensure and comment parameters in puppet resource, only return aliases if present
- mailalias: fix missing ensure parameter in puppet resource
- specs: added comprehensive test harness for both providers
0.0.3
- all: add instances methods to enable
puppet resource
0.0.2
- mailalias: new provider added for builtin mailalias type
0.0.1
- host: new provider added for builtin host type
* This Changelog was automatically generated by github_changelog_generator
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.