<NME> README.md
<BEF> # gitlab Cookbook (CE)

Configures the different components needed for an Omnibus installation of GitLab

### rails_migration

#### properties

* `name` (name property): A descriptive and unique name that will be used as part of the bash resource name
* `logfile_prefix` A unique file prefix name that will be used to create migration log files. Required
* `rake_task` A rails task that will be executed to migrate/setup the application. Required
* `helper` RailsMigrationHelper instance or a subclass of it with its required customized attributes. Required.
* `environment` A hash of environmental variables that needs to be set when running the rake task. Optional
* `dependent_services` An array of chef resource references that will be notified for restart when successful. Optional

#### example

Run database migrations for example-product

```ruby
rails_migration 'rails-app' do
  rake_task 'db:migrate'
  logfile_prefix 'rails-app-db-migrate'
  helper RailsAppMigrationHelper.new(node)
  dependent_services ['runit_service[puma]']
end
```

<MSG> Merge branch 'brodock/gitlab-resource-docs' into 'master'

Document `gitlab` cookbook resources

See merge request gitlab-org/omnibus-gitlab!5168
<DFF> @@ -1,3 +1,55 @@
 # gitlab Cookbook (CE)
 
 Configures the different components needed for an Omnibus installation of GitLab
+
+## Resources
+
+### database_objects
+
+Utility resource to configure user, database and resources for running GitLab
+
+#### properties
+
+* `pg_helper`: The helper object for interacting with the running database. Required
+* `account_helper`: The helper object for handling OS accounts. Required
+
+### puma_config
+
+Generate puma.rb configuration file
+
+#### properties
+
+* `filename`: (name_property): Full path to the configuration file to be generated
+* `tag`: Additonal text to display on process listing. Default: `gitlab-puma-worker`
+* `rackup`: Name of the rackup configuration file. Default: `config.ru`
+* `environment`: App server environment to run the app. Default: `production`
+* `install_dir`: Base omnibus installation directory. Default: `node['package']['install-dir']`
+* `listen_socket`: Full path of the socket to listen on. Optional
+* `listen_tcp`: TCP address and port to listen on. Optional
+* `working_directory`: Directory to run puma from. Optional
+* `worker_timeout`: Puma worker timeout. Default: `60`
+* `per_worker_max_memory_mb`: Puma max memory per worker (in MB). Optional
+* `worker_processes, Integer`: Puma number of worker process. Default: `2`
+* `min_threads`: Puma min number of threads. Default: `4`
+* `max_threads`: Puma max number of threads. Default: `4`
+* `pid`: Puma full path to create PID file. Optional
+* `state_path`: Puma full path to where state files will be stored. Optional
+* `stderr_path`: Puma stderr path. Optional
+* `stdout_path`: Puma stdout path. Optional 
+* `owner`: User owning configuration files. Default: `root`
+* `group`: Group owning configuration files. Default: `root`
+* `mode`: Filesystem permission flags. Default: `0644`
+* `dependent_services`: List of dependent services that will need to be restarted. Optional
+* `cookbook`: Cookbook from where the template will be fetched
+
+### sidekiq_service
+
+Configure runit service for running sidekiq
+
+#### properties
+
+* `rails_app`: Rails app setting passed to runit options. Default: `gitlab-rails`
+* `user`: System user who will own the runit service. Default: `node['gitlab']['user']['username']`
+* `group`: System group who will own the runit service. Default: `node['gitlab']['user']['group']`
+* `log_directory`: Path to where runit will store logs for this service. Optional
+* `template_name`: Runit template name. Default: `sidekiq`

{'commit': "diff --git a/files/gitlab-cookbooks/gitlab/README.md b/files/gitlab-cookbooks/gitlab/README.md\nindex 1accf79fe..c7fdc05bb 100644\n--- a/files/gitlab-cookbooks/gitlab/README.md\n+++ b/files/gitlab-cookbooks/gitlab/README.md\n@@ -1,3 +1,55 @@\n # gitlab Cookbook (CE)\n \n Configures the different components needed for an Omnibus installation of GitLab\n+\n+## Resources\n+\n+### database_objects\n+\n+Utility resource to configure user, database and resources for running GitLab\n+\n+#### properties\n+\n+* `pg_helper`: The helper object for interacting with the running database. Required\n+* `account_helper`: The helper object for handling OS accounts. Required\n+\n+### puma_config\n+\n+Generate puma.rb configuration file\n+\n+#### properties\n+\n+* `filename`: (name_property): Full path to the configuration file to be generated\n+* `tag`: Additonal text to display on process listing. Default: `gitlab-puma-worker`\n+* `rackup`: Name of the rackup configuration file. Default: `config.ru`\n+* `environment`: App server environment to run the app. Default: `production`\n+* `install_dir`: Base omnibus installation directory. Default: `node['package']['install-dir']`\n+* `listen_socket`: Full path of the socket to listen on. Optional\n+* `listen_tcp`: TCP address and port to listen on. Optional\n+* `working_directory`: Directory to run puma from. Optional\n+* `worker_timeout`: Puma worker timeout. Default: `60`\n+* `per_worker_max_memory_mb`: Puma max memory per worker (in MB). Optional\n+* `worker_processes, Integer`: Puma number of worker process. Default: `2`\n+* `min_threads`: Puma min number of threads. Default: `4`\n+* `max_threads`: Puma max number of threads. Default: `4`\n+* `pid`: Puma full path to create PID file. Optional\n+* `state_path`: Puma full path to where state files will be stored. Optional\n+* `stderr_path`: Puma stderr path. Optional\n+* `stdout_path`: Puma stdout path. Optional \n+* `owner`: User owning configuration files. Default: `root`\n+* `group`: Group owning configuration files. Default: `root`\n+* `mode`: Filesystem permission flags. Default: `0644`\n+* `dependent_services`: List of dependent services that will need to be restarted. Optional\n+* `cookbook`: Cookbook from where the template will be fetched\n+\n+### sidekiq_service\n+\n+Configure runit service for running sidekiq\n+\n+#### properties\n+\n+* `rails_app`: Rails app setting passed to runit options. Default: `gitlab-rails`\n+* `user`: System user who will own the runit service. Default: `node['gitlab']['user']['username']`\n+* `group`: System group who will own the runit service. Default: `node['gitlab']['user']['group']`\n+* `log_directory`: Path to where runit will store logs for this service. Optional\n+* `template_name`: Runit template name. Default: `sidekiq`\n", 'commit_subject': "Merge branch 'brodock/gitlab-resource-docs' into 'master'", 'repo_name': 'gitlabhq/omnibus-gitlab', 'committer': {'name': 'Ian Baum', 'email': '74a8510ab9a4c7c312651012ae5ff001a83f86dc@gitlab.com', 'time_sec': '1619705361', 'tz_offset': '0', 'date': {'seconds': '1619705361'}}, 'commit_tree': '23fa2a1cd794a0cb15638447c26ed91bd1bc985d', 'commit_message': "Merge branch 'brodock/gitlab-resource-docs' into 'master'\n\nDocument `gitlab` cookbook resources\n\nSee merge request gitlab-org/omnibus-gitlab!5168", 'language_name': 'Shell', 'license': 'apache-2.0', 'hunks': "@@ -1,3 +1,55 @@\n # gitlab Cookbook (CE)\n \n Configures the different components needed for an Omnibus installation of GitLab\n+\n+## Resources\n+\n+### database_objects\n+\n+Utility resource to configure user, database and resources for running GitLab\n+\n+#### properties\n+\n+* `pg_helper`: The helper object for interacting with the running database. Required\n+* `account_helper`: The helper object for handling OS accounts. Required\n+\n+### puma_config\n+\n+Generate puma.rb configuration file\n+\n+#### properties\n+\n+* `filename`: (name_property): Full path to the configuration file to be generated\n+* `tag`: Additonal text to display on process listing. Default: `gitlab-puma-worker`\n+* `rackup`: Name of the rackup configuration file. Default: `config.ru`\n+* `environment`: App server environment to run the app. Default: `production`\n+* `install_dir`: Base omnibus installation directory. Default: `node['package']['install-dir']`\n+* `listen_socket`: Full path of the socket to listen on. Optional\n+* `listen_tcp`: TCP address and port to listen on. Optional\n+* `working_directory`: Directory to run puma from. Optional\n+* `worker_timeout`: Puma worker timeout. Default: `60`\n+* `per_worker_max_memory_mb`: Puma max memory per worker (in MB). Optional\n+* `worker_processes, Integer`: Puma number of worker process. Default: `2`\n+* `min_threads`: Puma min number of threads. Default: `4`\n+* `max_threads`: Puma max number of threads. Default: `4`\n+* `pid`: Puma full path to create PID file. Optional\n+* `state_path`: Puma full path to where state files will be stored. Optional\n+* `stderr_path`: Puma stderr path. Optional\n+* `stdout_path`: Puma stdout path. Optional \n+* `owner`: User owning configuration files. Default: `root`\n+* `group`: Group owning configuration files. Default: `root`\n+* `mode`: Filesystem permission flags. Default: `0644`\n+* `dependent_services`: List of dependent services that will need to be restarted. Optional\n+* `cookbook`: Cookbook from where the template will be fetched\n+\n+### sidekiq_service\n+\n+Configure runit service for running sidekiq\n+\n+#### properties\n+\n+* `rails_app`: Rails app setting passed to runit options. Default: `gitlab-rails`\n+* `user`: System user who will own the runit service. Default: `node['gitlab']['user']['username']`\n+* `group`: System group who will own the runit service. Default: `node['gitlab']['user']['group']`\n+* `log_directory`: Path to where runit will store logs for this service. Optional\n+* `template_name`: Runit template name. Default: `sidekiq`\n", 'addition_count': 52, 'deletion_count': 0, 'src_file': 'a/files/gitlab-cookbooks/gitlab/README.md', 'tgt_file': 'b/files/gitlab-cookbooks/gitlab/README.md', 'file_extension': '.md', 'before_file': "# gitlab Cookbook (CE)\n\nConfigures the different components needed for an Omnibus installation of GitLab\n\n### rails_migration\n\n#### properties\n\n* `name` (name property): A descriptive and unique name that will be used as part of the bash resource name\n* `logfile_prefix` A unique file prefix name that will be used to create migration log files. Required\n* `rake_task` A rails task that will be executed to migrate/setup the application. Required\n* `helper` RailsMigrationHelper instance or a subclass of it with its required customized attributes. Required.\n* `environment` A hash of environmental variables that needs to be set when running the rake task. Optional\n* `dependent_services` An array of chef resource references that will be notified for restart when successful. Optional\n\n#### example\n\nRun database migrations for example-product\n\n```ruby\nrails_migration 'rails-app' do\n  rake_task 'db:migrate'\n  logfile_prefix 'rails-app-db-migrate'\n  helper RailsAppMigrationHelper.new(node)\n  dependent_services ['runit_service[puma]']\nend\n```\n", 'message': "Merge branch 'brodock/gitlab-resource-docs' into 'master'\n\nDocument `gitlab` cookbook resources\n\nSee merge request gitlab-org/omnibus-gitlab!5168", 'author_name': 'Ian Baum', 'lang': 'md'}