Version information
This version is compatible with:
- Puppet Enterprise 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, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
- OracleLinux, Scientific, Fedora, Rocky, AlmaLinux, SLES, , , FreeBSD, DragonFly, ArchLinux , ,
Start using this module
Add this module to your Puppetfile:
mod 'rehan-git', '2.0.3'
Learn more about managing modules with a PuppetfileDocumentation
rehan-git
Table of Contents
Overview
The rehan-git
module manages the Git, the distributed revision control system.
Module Description
A puppet module for managing the installation and configuration of git so that it is available to be used by
puppetlabs-vcsrepo
module. This module installs and configures the git package and allows configuration of user
specific git settings.
Where possible, this module can be used to ensure the git installation is up to date with latest upstream release of git. Currently, this feature is supported for the following OSes:
- Ubuntu (using ppa:git-core/ppa )
Implemented Features:
- Installs git from packages
- Optionally installs package from upstream git sources (only on Ubuntu using ppa).
- Initialising user accounts with git configurations.
Features not yet updated
- Configure system wide git configurations
Setup
In order to install rehan-git
, run the following command:
$ puppet module install rehan-git
The module does expect all the data to be provided through 'Hiera'. See Usage for examples on how to configure it.
Requirements
This module is designed to be as clean and complient with latest puppet code guidelines.
Usage
Classes
git
A basic install with the defaults would be:
include git
Otherwise using the parameters:
class{ 'git':
sources_manage => true,
sources_repo => 'ppa:git-core/ppa',
sources_ensure => present,
package_ensure => latest,
package_name => 'git',
}
Parameters
- sources_manage: Controls the upstream source management feature. The default is
false
. - sources_repo: Defines the upstream source repository. The default value is OS dependent.
- sources_ensure: Sets the ensure parameter passed to the upstream source repo repository. The default is
present
. - package_ensure: Sets the ensure parameter passed to the package. The default is
latest
. - package_ensure: Provides the package name to be installed. The default is
git
. - users: A hash of git user profiles, see
git:user
for more details.
All of this data can be provided through Hiera
.
YAML
git::sources_manage: true
git::sources_repo: 'ppa:git-core/ppa'
git::sources_ensure: present
git::package_ensure: latest
git::package_name: 'git'
git::users:
alice:
user_email: 'alice@xyz.com'
user_name: 'Alice Alic'
bob:
user_email: 'bob@test.com'
user_name: 'Bob Builder'
gitconfig:
color:
ui: true
push:
default: simple
pull:
ff: only
fetch:
prune: true
Resources
git::user
This defined type is used to set the per user .gitconfig file. It includes the users' name and email. The username should be a valid user account that has been managed by Puppet. The gitconfig sections is a hash of values that go in the users' .gitconfig file. See git-scm for details.
Usage:
git::user{'alice':
user_name => 'Alice Alic',
user_email => 'alice@xyz.com',
gitconfig => {
'color' => {
ui => true,
},
'push' => {
default => 'simple',
},
'pull' => {
ff => 'only',
},
'fetch' => {
prune => true,
},
}
}
Parameters
- ensure could be set to
present
orabsent
, the default ispresent
. - user_name sets the user's name to the specified string.
- user_email sets the user's email address to the specified string.
- gitconfig A hash of values that go in .gitconfig file of the user., the default is as shown in the example above.
Dependencies
Development
You can submit pull requests and create issues through the official page of this module on GitHub. Please do report any bug and suggest new features/improvements.
2.0.3 (December 8, 2022)
Improvements:
- Updated dependency versions.
2.0.2 (December 8, 2022)
Improvements:
- Updated os support matrix.
- Updated
pdk
templates.
2.0.1 (November 19, 2021)
Bugfixes:
- Fixed os support matrix.
- Fixed minimum supported
puppet
version.
2.0.0 (November 18, 2021)
Improvements:
- Updated os support matrix.
- Updated
pdk
templates. - Updated minimum
puppet
version to6.0.0
. - Updated dependency versions.
1.6.0 (September 29, 2021)
Improvements:
- Introduce a new
gitconfig
option for controlling the per user config files.
Removed:
- Removed
color_ui
option from the user config. - Removed
push_default
option fror the user config.
1.5.2 (September 29, 2021)
Improvements:
- Updated
pdk
templates. - Updated os support matrix.
- Added support for Rockylinux.
1.5.1 (May 6, 2021)
Improvements:
- Updated links to travis-ci.
1.5.0 (May 4, 2021)
Features:
- Added support for openSUSE Leap.
Improvements:
- Updated
pdk
templates. - Updated os support matrix.
- Added system tests for openSuse Leap 15.
1.4.1 (April 29, 2020)
Improvements:
- Added support for Ubuntu 20.04.
- Updated
pdk
templates.
1.4.0 (February 13, 2020)
Improvements:
- Added support for CentOS 8.
- Updated os support matrix.
- Updated
pdk
templates.
1.3.0 (August 25, 2019)
Improvements:
- Added support for Debian 10.
- Updated os support matrix.
- Updated
pdk
templates.
1.2.2 (June 15, 2019)
Improvements:
- Updated minimum
puppet
version to 5.5.10. - Updated os support matrix.
1.2.1 (January 03, 2019)
Improvements:
- Updated
pdk
templates.
1.2.0 (October 14, 2018)
Improvements:
- Updated
pdk
templates. - Added support for
puppet
version 6.
1.1.4 (August 31, 2018)
Improvements:
- Updated
pdk
templates. - Added tests for Debian 9 release.
- Updated
puppetlabs-stdlib
dependency version. - Fixed minor documentation issues.
1.1.3 (July 29, 2018)
Improvements:
- Updated
pdk
templates. - Updated module dependency versions.
1.1.2 (June 30, 2018)
Improvements:
- Updated
pdk
templates. - Added tests for Ubuntu 18.04 release.
- Fixed minor documentation issues.
1.1.1 (May 6, 2018)
Improvements:
- Updated
pdk
templates. - Updated minimum required
puppet
version to4.10.0
.
1.1.0 (April 19, 2018)
Improvements:
- Updated module data to
hiera 5
.
1.0.0 (April 19, 2018)
Improvements:
- Updated module to be
pdk
compliant.
0.6.0 (February 17, 2018)
Improvements:
- Added support for Puppet 5.
- Updated OS support matrix.
0.5.0 (June 11, 2017)
Improvements:
- Replace deprecated
hiera_hash
tolookup
. - Update minimum puppet version required is set to
4.7.0
.
0.4.0 (March 27, 2017)
Features:
- Convert templates from .erb to .epp.
- Updated puppetlabs-apt dependency version upper limit.
Bugfixes:
- Fix the style issues in chaining arrows.
0.3.0 (March 27, 2017)
Features:
- Added
package_manage
parameter to allow disabling management of package resource. - Increased unit and acceptance tests coverage.
0.2.0 (December 25, 2016)
Features:
- Introduce proper Puppet 4 types for parameters.
- Remove legacy validate statements of puppet-stdlib module.
- Increased unit and acceptance tests coverage.
0.1.3 (May 23, 2016)
Bugfixes:
- Fix the facts hash usage to allow ppa repo on Ubuntu systems.
0.1.2 (May 19, 2016)
Features:
- Update supported os matrix.
Bugfixes:
- Improved handling of ensure parameter on
git::user
. - Documentation typo fixes.
0.1.1 (May 14, 2016)
Bugfixes:
- Minor typo fixes.
0.1.0 (May 14, 2016)
Features:
- Initial release
Dependencies
- puppetlabs-stdlib (>= 6.0.0 < 9.0.0)
- puppetlabs-apt (>= 6.0.0 < 10.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.