Merge pull request #467 from yakatz/document_data_dir

Add documentation for git_data_dir change in Gitlab 18

Author: yakatz

REFERENCE.md

@@ -16,8 +16,8 @@
 
 ### Defined types
 
-* [`gitlab::custom_hook`](#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. Only one of each is currently supported by this module.
-* [`gitlab::global_hook`](#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.
+* [`gitlab::custom_hook`](#gitlab--custom_hook): Manage custom hook files within a GitLab project.
+* [`gitlab::global_hook`](#gitlab--global_hook): Manage global chain loaded hook files for all GitLab projects.
 * [`gitlab::system_hook`](#gitlab--system_hook): A file hook will run on each event so it's up to you to filter events or projects
 
 ### Tasks
@@ -352,6 +352,37 @@ Data type: `Optional[Hash]`
 
 Hash of git data directories
 
+**Deprecated**: This option was removed in Gitlab 18.
+
+To configure the storage location for a Gitaly node:
+```patch
+-        git_data_dirs           => {
+-            'default' => { 'path' => '/mnt/example/git-data'},
+-        },
++        gitaly                  => {
++            configuration => {
++                'storage' => [
++                    {
++                        'name' => 'default',
++                        'path' => '/mnt/example/git-data/repositories',
++                    },
++                ],
++            },
++        },
+```
+
+To configure the storage location for other nodes:
+```patch
+-        git_data_dirs           => {
+-            'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075'},
+-        },
++        gitlab_rails            => {
++            repositories_storages => {
++                'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075'},
++            },
++        },
+```
+
 Default value: `undef`
 
 ##### <a name="-gitlab--gitlab_git_http_server"></a>`gitlab_git_http_server`
@@ -1212,7 +1243,8 @@ Default value: `$gitlab::skip_post_deployment_migrations`
 
 ### <a name="gitlab--custom_hook"></a>`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. Only one of each is currently supported by this module.
+Custom hooks can be created as a pre-receive, post-receive, or update hook.
+Only one of each is currently supported by this module.
 
 #### Examples
 
@@ -1305,7 +1337,9 @@ Default value: `false`
 
 ### <a name="gitlab--global_hook"></a>`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.
+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.
 
 #### Examples
 

manifests/custom_hook.pp

@@ -1,4 +1,6 @@
-# @summary Manage custom hook files within a GitLab project. Custom hooks can be created as a pre-receive, post-receive, or update hook. Only one of each is currently supported by this module.
+# @summary Manage custom hook files within a GitLab project.
+# Custom hooks can be created as a pre-receive, post-receive, or update hook.
+# Only one of each is currently supported by this module.
 #
 # @example Custom hook usage
 #   gitlab::custom_hook { 'my_custom_hook':

manifests/global_hook.pp

@@ -1,4 +1,7 @@
-# @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.
+# @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':

manifests/init.pp

@@ -27,6 +27,37 @@
 # @param git Hash of 'omnibus_gitconfig' config parameters.
 # @param gitaly Hash of 'omnibus_gitconfig' config parameters.
 # @param git_data_dirs Hash of git data directories
+#
+#        **Deprecated**: This option was removed in Gitlab 18.
+#
+#        To configure the storage location for a Gitaly node:
+#        ```patch
+#        -        git_data_dirs           => {
+#        -            'default' => { 'path' => '/mnt/example/git-data'},
+#        -        },
+#        +        gitaly                  => {
+#        +            configuration => {
+#        +                'storage' => [
+#        +                    {
+#        +                        'name' => 'default',
+#        +                        'path' => '/mnt/example/git-data/repositories',
+#        +                    },
+#        +                ],
+#        +            },
+#        +        },
+#        ```
+#
+#        To configure the storage location for other nodes:
+#        ```patch
+#        -        git_data_dirs           => {
+#        -            'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075'},
+#        -        },
+#        +        gitlab_rails            => {
+#        +            repositories_storages => {
+#        +                'default' => { 'gitaly_address' => 'tcp://gitaly1.internal:8075'},
+#        +            },
+#        +        },
+#        ```
 # @param gitlab_git_http_server Hash of 'gitlab_git_http_server' config parameters.
 # @param gitlab_ci Hash of 'gitlab_ci' config parameters.
 # @param gitlab_kas Hash of 'gitlab_kas' config parameters.