Move documentation to puppet-strings

manifests/backup.pp

@@ -1,7 +1,4 @@
-# == Class gitlab::backup
-#
-# This class is called from gitlab for backup config.
-#
+# @summary This class is called from gitlab for backup config.
 class gitlab::backup {
   $rake_exec = $gitlab::rake_exec
   $backup_cron_enable = $gitlab::backup_cron_enable

manifests/custom_hook.pp

@@ -1,62 +1,19 @@
-# == Define: gitlab::custom_hook
-#
-# Manage custom hook files within a GitLab project. Custom hooks can be created
-# as a pre-receive, post-receive, or update hook. It's possible to create
-# different custom hook types for the same project - one each for pre-receive,
-# post-receive and update.
-#
-# === Parameters
-#
-# [*namevar*]
-#   The namevar is arbitrary and is not used directly. Supply a descriptive
-#   namevar of your choosing.
-#
-# [*namespace*]
-#   The GitLab group namespace for the project.
-#
-# [*project*]
-#   The GitLab project name.
-#
-# [*type*]
-#   The custom hook type. Should be one of pre-receive, post-receive, or update.
-#
-# [*content*]
-#   Specify the custom hook contents either as a string or using the template
-#   function. If this paramter is specified source parameter must not be
-#   present.
-#
-# [*source*]
-#   Specify a file source path to populate the custom hook contents. If this
-#   paramter is specified content parameter must not be present.
-#
-# [*repos_path*]
-#   The GitLab shell repos path. This defaults to
-#   '/var/opt/gitlab/git-data/repositories' if not present.
-#
-# [*git_username*]
-#   The git user name. Defaults to 'git' if not present.
-#
-# [*git_groupname*]
-#   The git group name. Defaults to 'git' if not present.
-#
-#
-# === Examples
+# @summary Manage custom hook files within a GitLab project. Custom hooks can be created as a pre-receive, post-receive, or update hook. It's possible to create different custom hook types for the same project - one each for pre-receive, post-receive and update.
 #
+# @example Custom hook usage
 #   gitlab::custom_hook { 'my_custom_hook':
 #     namespace       => 'my_group',
 #     project         => 'my_project',
 #     type            => 'post-receive',
 #     source          => 'puppet:///modules/my_module/post-receive',
 #   }
 #
-# === Authors
-#
-# Drew A. Blessing <[email protected]>
-#
-# === Copyright
-#
-# Copyright 2014 Spencer Owen, unless otherwise noted.
-#
+# @param namespace The GitLab group namespace for the project.
+# @param project The GitLab project name.
+# @param type The custom hook type. Should be one of pre-receive, post-receive, or update.
+# @param content Specify the custom hook contents either as a string or using the template function. If this paramter is specified source parameter must not be present.
+# @param source Specify a file source path to populate the custom hook contents. If this paramter is specified content parameter must not be present.
+# @param repos_path The GitLab shell repos path. This defaults to '/var/opt/gitlab/git-data/repositories' if not present.
 define gitlab::custom_hook(
   String                                        $namespace,
   String                                        $project,

manifests/global_hook.pp

@@ -1,57 +1,15 @@
-# == Define: gitlab::global_hook
-#
-# Manage global chain loaded hook files for all GitLab projects. Hooks can be created
-# as a pre-receive, post-receive, or update hook. It's possible to create
-# multipe hooks per type as long as their names are unique.
-#
-# Support for chained (global) hooks is introduced in GitLab Shell 4.1.0 and GitLab 8.15.
-#
-# === Parameters
-#
-# [*namevar*]
-#   The namevar is used as chail file name and should be unique. Supply a descriptive
-#   namevar of your choosing.
-#
-# [*type*]
-#   The custom hook type. Should be one of pre-receive, post-receive, or update.
-#
-# [*content*]
-#   Specify the custom hook contents either as a string or using the template
-#   function. If this paramter is specified source parameter must not be
-#   present.
-#
-# [*source*]
-#   Specify a file source path to populate the custom hook contents. If this
-#   paramter is specified content parameter must not be present.
-#
-# [*custom_hooks_dir*]
-#   The GitLab shell repos path. This defaults to
-#   '/opt/gitlab/embedded/service/gitlab-shell/hooks' if not present.
-#
-# [*git_username*]
-#   The git user name. Defaults to 'git' if not present.
-#
-# [*git_groupname*]
-#   The git group name. Defaults to 'git' if not present.
-#
-#
-# === Examples
+# @summary Manage global chain loaded hook files for all GitLab projects. Hooks can be created as a pre-receive, post-receive, or update hook. It's possible to create  multipe hooks per type as long as their names are unique. Support for chained (global) hooks is introduced in GitLab Shell 4.1.0 and GitLab 8.15.
 #
+# @example Global hook usage
 #   gitlab::custom_hook { 'my_custom_hook':
 #     type            => 'post-receive',
 #     source          => 'puppet:///modules/my_module/post-receive',
 #   }
 #
-# === Authors
-# Hidde Boomsma <[email protected]>
-#
-# Inspired by the custom_hook module by:
-# Drew A. Blessing <[email protected]>
-#
-# === Copyright
-#
-# Copyright 2017 Hidde Boomsma
-#
+# @param type The custom hook type. Should be one of pre-receive, post-receive, or update.
+# @param custom_hooks_dir The GitLab shell repos path. This defaults to '/opt/gitlab/embedded/service/gitlab-shell/hooks' if not present.
+# @param content Specify the custom hook contents either as a string or using the template function. If this paramter is specified source parameter must not be present.
+# @param source Specify a file source path to populate the custom hook contents. If this paramter is specified content parameter must not be present.
 define gitlab::global_hook (
   Enum['post-receive', 'pre-receive', 'update'] $type,
   Stdlib::Absolutepath                          $custom_hooks_dir,

manifests/host_config.pp

@@ -1,12 +1,12 @@
-# == Class gitlab::host_config
+# @summary This class is for setting host configurations required for gitlab installation.
 #
-# This class is for setting host configurations required for gitlab installation
-#
-# [*config_dir*]
-#   Default: '/etc/gitlab'
-#   The service executable path.
-#   Provide this variable value only if the service executable path
-#   would be a subject of change in future GitLab versions for any reason.
+# @param config_dir The service executable path. Provide this variable value only if the service executable path would be a subject of change in future GitLab versions for any reason.
+# @param skip_auto_migrations Deprecated if using Gitlab > 10.6.4 and < 11.0.0, unsupported by gitlab omnibus using gitlab 11+. Use skip_auto_reconfigure
+# @param skip_auto_reconfigure Utilized for Zero Downtime Updates, See: https://docs.gitlab.com/omnibus/update/README.html#zero-downtime-updates
+# @param store_git_keys_in_db Enable or disable Fast Lookup of authorized SSH keys in the database. See: https://docs.gitlab.com/ee/administration/operations/fast_ssh_key_lookup.html
+# @param pgpass_file_ensure Create .pgpass file for pgbouncer authentication. When set to present requires valid value for pgbouncer_password.
+# @param pgpass_file_location Path to location of .pgpass file used by consul to authenticate with pgbouncer database
+# @param pgbouncer_password Password for the gitlab-consul database user in the pgbouncer database
 class gitlab::host_config (
   $config_dir = '/etc/gitlab',
   $skip_auto_migrations = $gitlab::skip_auto_migrations,