Skip to content

Proposal to centralize documentation regarding object store connections

This issue's original intent was to add a snippet to the docs regarding openstack configuration. Whilst considering doing that, I'm floating the idea to centralize the documentation for object store connections instead, resulting in a single source to which the other documentation can refer to.

A similar snippet is shown in uploads and job-artifact.

gitlab_rails['lfs_object_store_enabled'] = true
gitlab_rails['lfs_object_store_remote_directory'] = "lfs-objects"
gitlab_rails['lfs_object_store_connection'] = {
 'provider' => 'OpenStack',
 'openstack_username' => 'OPENSTACK_USERNAME',
 'openstack_api_key' => 'OPENSTACK_PASSWORD',
 'openstack_temp_url_key' => 'OPENSTACK_TEMP_URL_KEY',
 'openstack_auth_url' => 'https://auth.cloud.ovh.net/v2.0/',
 'openstack_region' => 'DE1',
 'openstack_tenant' => 'TENANT_ID',
}

Original description

Ticket: 156706

Agent: Nourdin el Bacha


Hi @marcel.amirault and @marcia

I've pinged the both of you, since y'all are the technical writers (I think) of this issue's original intention.


Currently we have documented how to use S3 for your uploads, lfs, artifacts, etc. These are rather large, containing snippets for Omnibus installations, and source installations. I would like to propose that we create a dedicated page containing snippets for the Fog supported configuration options.

In this page, we can then also address that if you want to change the purpose of the setting, that you can do so by specifying that in place of <type>, i.e. replacing <type> with lfs:

gitlab_rails['<type>_object_store_enabled'] = true
gitlab_rails['<type>_object_store_remote_directory'] = "<type>-objects"
gitlab_rails['<type>_object_store_connection'] = {
  ...
}

I would like drive this forward and see where it goes, but before I start working on this I was wondering what your take is on this.

Edited by Marcin Sedlak-Jakubowski