gitolite
Version information
This version is compatible with:
- Puppet Enterprise >= 3.2.0 < 5.0.0
- Puppet >= 3.0.0 < 5.0.0
- Debian,Ubuntu,Redhat,CentOS,OracleLinux,Scientific,SLES
Start using this module
Add this module to your Puppetfile:
mod 'echoes-gitolite', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
gitolite
[]
(https://travis-ci.org/echoes-tech/puppet-gitolite)
[
]
(https://flattr.com/submit/auto?user_id=echoes&url=https://forge.puppetlabs.com/echoes/gitolite&title=Puppet%20module%20to%20manage%20Gitolite&description=This%20module%20installs%20and%20configures%20Gitolite.&lang=en_GB&category=software "Puppet module to manage Gitolite installation and configuration")
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with gitolite
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors
Overview
Puppet module to manage Gitolite installation and configuration.
Module Description
This module installs and configures Gitolite.
Setup
Setup Requirements
WARNING: For RedHat systems, you may need to add an additional repository like the EPEL repository. You can use the module stahnma-epel to do this.
Beginning with gitolite
The quickest way to be up and running using the gitolite module is to copy your public SSH key in the files folder of this module. So, you can use this syntax:
class { 'gitolite':
admin_key_source => "puppet:///modules/gitolite/id_rsa.pub",
}
Usage
Use content parameter instead of source parameter
class { 'gitolite':
admin_key_content => "ssh-dss AAAAB3NzaC1kc3MAAaCBANzDfIs7n5Co8zEa+dWgr6VzPFrTKsFmaG4l1JPa/XZWId9b4J+Cdf53cCCanUt9K8tFOeuo5TEzy+rS+O48G/R+tpv/iY8wJp7gqdBK2j65JPocLTMZ48rprDTNtg35FJZp6gSbiie7iml9QQUFSzAPOWkA6hP/CcEkh3NiCd0RAAAAFQCrQJliYVH1sXBh5ppC+IDa3j/arQAAAIAYHjea9fGUX31fIRENyIqwVxlX7x3e48XnVJNfZrzC+NSI5BhwnDD5Hb9ls0GOq4kSIkTajmCcb+514YgW3jdlRwiFWbfQbf19CJ1Np6165knbBkGJESaG4+dfUGgkrWMP92k4MbXpmMsKterUq6UDVOIwq4Ke2uBa3iHI5VhdlQAAAIAJ3BawCZz5Ft2T+tHjaUulWRrhQnCv3xHQU8Juat71M9iqCKiNQntZoDAiMrf9h9vGg+ya2ILcplf9zdNwOSVGPebF5S4BqY+LrC7tYcjRrWkrQkioywya1y8+Qt9uqksvcRh7T4WC3yMgbG3NqSHKl51ncDVw7gLzoIURt9Oimw== florent@echoes",
}
Reference
Classes
Public Classes
- gitolite: Main class, includes all other classes.
Private Classes
- gitolite::install: Handles the packages.
- gitolite::config: Handles the configuration file.
Parameters
The following parameters are available in the ::gitolite class:
admin_key_content
Tells Puppet what content of administration SSH key to add to Gitolite. Exclusive with the source parameter. Valid options: string. Default value: undef
admin_key_source
Tells Puppet which path of administration SSH key to add to Gitolite. Exclusive with the content parameter. Valid options: string. Default value: undef
allow_local_code
Tells Puppet whether the LOCAL_CODE setting of .gitolite.rc file is enabled. Valid options: boolean. Default value: false
The value of LOCAL_CODE is $ENV{HOME}/local. This option is only available for Gitolite 3.
For more details, see : http://gitolite.com/gitolite/non-core.html#localcode
git_config_keys
This setting of .gitolite.rc file allows the repo admin to define acceptable gitconfig keys. Valid options: string. Default value: empty
For more details, see : http://gitolite.com/gitolite/rc.html#specific-variables
group_name
Tells Puppet which Gitolite group name to manage. Valid options: string. Default value: varies by operating system
home_dir
Tells Puppet which Gitolite home directory to manage. Valid options: string containing an absolute path. Default value: '/var/lib/gitolite'
local_code_in_repo
Tells Puppet whether the LOCAL_CODE setting of .gitolite.rc file is set to a director in the gitolite-admin repository. Must also set allow_local_code parameter to true. Valid options: boolean. Default value: false
The value of LOCAL_CODE is $rc{GL_ADMIN_BASE}/local. This option is only available for Gitolite 3.
SECURITY WARNING: Enabling this setting will allow anyone with write access to the gitolite-admin repository to execute arbitrary code on the gitolite server.
local_code_path
Tells Puppet what the path of LOCAL_CODE setting of .gitolite.rc file is. Valid options: string. Default value: 'local'
manage_user
Whether the user/group resources will be managed by this module. Default value: true
package_ensure
Tells Puppet whether the Gitolite package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'
package_name
Tells Puppet which Gitolite package to manage. Valid options: string. Default value: varies by operating system
repo_specific_hooks
Tells Puppet whether to enable the repo-specific-hooks feature in .gitolite.rc. Valid options: boolean. Default value: false
This option is only available for Gitolite 3.
umask
This setting of .gitolite.rc file controls file permissions for gitolite repositories. Set this to 0027, for example, to allow the group_name group to read newly created repos. Default value: 0077
user_name
Tells Puppet which Gitolite user name to manage. Valid options: string. Default value: varies by operating system
version
Tells Puppet which Gitolite version to manage. Valid options: '2' or '3'. Default value: varies by operating system
Limitations
RedHat and Debian family OSes are officially supported. Tested and built on Debian and CentOS.
Development
Echoes Technologies modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great.
Contributors
The list of contributors can be found at: https://github.com/echoes-tech/puppet-gitolite/graphs/contributors
2017-02-28 - Release 1.0.0
Summary
This release fixes typo and adds a lot of test improvements.
2015-02-29 - Release 0.4.0
Summary
This release adds options to custom the .gitolite.rc files and many tests.
Features
- Added parameter to set local code path
- Added parameter to manage Gitolite version
Tests
- Improved Travis configuration
- Added specs
Bugfixes
- Fixed bad permissions on PuppetLabs forge package
2015-10-12 - Release 0.3.0
Summary
This release adds many options to custom the .gitolite.rc file.
Features
- Added parameter to store local code in gitolite-admin repo
- Added parameter to enable repo-specific-hooks feature
- Added manage_user parameter to control whether this module manages user/group resources
- Added umask parameter
2015-09-17 - Release 0.2.2
Summary
This release fixes a typo for PE2015.2.
2015-08-06 - Release 0.2.1
Summary
This release updates metadata, the README file, as well as test improvements.
Tests
- Added future parser in Travis matrix.
##2015-06-16 - Release 0.2.0 ###Summary This release adds the ability to manage some options of Gitolite configuration file.
####Features
- Added template of
.gitolite.rcfile - Added
git_config_keysparameter togitoliteclass and to the template of configuration file. - Added
allow_local_codeparameter togitoliteclass.
##2015-06-16 - Release 0.1.2 ###Summary This is the initial release
####Fixed
- Contains default stdlib dependency and licence syntax in metadata.json
##2015-06-16 - Release 0.1.0 ###Summary This is the initial release
####Features
- Installs and configures Gitolite for Debian, Ubuntu, RedHat and CentOS
Dependencies
- puppetlabs/stdlib (>= 4.6.0 < 6.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.