Permalink
Browse files

More documentation

  • Loading branch information...
1 parent 4f1322a commit c61f4d2fbefd4665ed8ecccbf4d668360dbbc847 @adrienthebo committed Apr 29, 2012
Showing with 96 additions and 15 deletions.
  1. +77 −12 README.markdown
  2. +11 −1 manifests/adc.pp
  3. +8 −2 manifests/install.pp
View
@@ -1,18 +1,83 @@
puppet-gitolite
===============
-Install and manage gitolite
+Install and manage gitolite with puppet.
-Defines
+Overview
+--------
- package { 'git': ensure => present } ->
- class { '::gitolite': }
- include gitolite::gitweb
+For more detail on any of the classes or defines, view the puppet doc in the
+relevant file.
- gitolite::adc { 'adc.common-functions': mode => '0600'}
- gitolite::adc { 'help': }
- gitolite::adc { 'hub': }
- gitolite::adc { 'fork': }
- gitolite::adc { 'unlock': }
- gitolite::adc { 'lock': }
- gitolite::adc { 'trash': }
+### Classes you might care about
+
+#### Class: gitolite
+
+Installs gitolite with all default values.
+
+#### Class: gitolite::gitweb
+
+Configure a gitweb instance built on top of this gitolite instance.
+
+#### Define: gitolite::adc
+
+Install gitolite ADCs. Requires gitolite 2 or greater.
+
+- - -
+
+### Classes you probably don't care about
+
+#### Class: gitolite::data
+
+Provides the default datasource for hiera lookup values
+
+#### Class: gitolite::install
+
+Installs gitolite from source, backports, or git.
+
+#### Class: gitolite::instance
+
+Creates a gitolite instance and the necessary prerequisite files.
+
+Example
+-------
+
+All listed ACDs are vendored and ready for installation. As always, pleaase
+read the documentation first.
+
+ package { 'git': ensure => present } -> # Install git
+ class { '::gitolite': } # Install gitolite with all default values
+ include gitolite::gitweb # Include gitweb access with gitolite based authorization.
+ #
+ # Install a motley of ADCs
+ #
+ # Install shared functions without execute access - library only
+ #
+ gitolite::adc { 'adc.common-functions': mode => '0600'}
+ #
+ # Github style commands
+ #
+ gitolite::adc { 'fork': } # github style forking
+ gitolite::adc { 'hub': } # Add in github style pull requests
+ #
+ # Repo management and deletion
+ #
+ gitolite::adc { 'list-trashed': } # List trashed repos
+ gitolite::adc { 'lock': } # Lock a repo
+ gitolite::adc { 'trash': } # Move a repository to the trash
+ gitolite::adc { 'unlock': } # Unlock a repo
+ gitolite::adc { 'restore': } # Move a repo from the trash
+ #
+ # Miscellaneous
+ #
+ gitolite::adc { 'help': } # help page for ADCs
+ gitolite::adc { 'htpasswd': } # Allow people to add an htpasswd entry. Needed for gitweb::gitolite
+ gitolite::adc { 'sskm': } # Self-serve public key management
+ # And many other ADCs...
+
+Requirements
+------------
+
+ * hiera
+ * puppetlabs-stdlib
+ * if the backports install is chosen, puppet-apt
View
@@ -1,9 +1,13 @@
-# Define: gitolite::adc
+# = Define: gitolite::adc
#
# Manage the installation and removal of gitolite admin defined commands
#
# == Parameters
#
+# [*title*]
+#
+# The name of the ADC to install.
+#
# [*ensure*]
#
# Whether to create or remove the ADC.
@@ -33,6 +37,12 @@
# gitolite::adc { 'lock': }
# gitolite::adc { 'trash': }
#
+# == Notes
+#
+# At the publishing of this module, all ADCs available at the time have been
+# vendored, so it if comes in gitolite/contrib, you can add it without having
+# to specify a source.
+#
# == Author
#
# Adrien Thebo <adrien@puppetlabs.com>
View
@@ -1,12 +1,18 @@
# = Class: gitolite::install
#
-# Installs gitolite
+# Installs gitolite from source, backports, or git.
#
# == Parameters
#
# [*source*]
#
-# The source to install from. One of [backports, git, package]
+# The source to install from.
+#
+# Available options:
+#
+# * backports - install from debian packports. Debian only.
+# * git - install the latest release from github.com/sitaramc/gitolite
+# * package - install from system packages.
#
# Default: hiera('gitolite_install_source')
#

0 comments on commit c61f4d2

Please sign in to comment.