Cell configuration

What does this MR do?

Adding the ability to add Cell configuration to OmniBus GitLab Instance

Addressing: gitlab#487059 (closed)

Reference: https://docs.gitlab.com/ee/administration/cells.html

NOTE: Documentation to be added separately in gitlab!180957 (merged) after this is merged

Steps to validate this MR

Prerequisites

You need a host that is running Docker. Preferably a VM on GCP. To install Docker, see: https://docs.docker.com/engine/install/

This docker image is built from this MR branch.

docker pull registry.gitlab.com/gitlab-org/omnibus-gitlab/gitlab-ee:487059-cell-configuration
docker tag registry.gitlab.com/gitlab-org/omnibus-gitlab/gitlab-ee:487059-cell-configuration omnibus
docker run --rm -d --name omnibus omnibus
docker exec -ti omnibus bash

After running the last command, you will be running commands inside a container that is running

Default settings

Validating the default values

gitlab-ctl reconfigure
gitlab-rails console
puts Settings.cell.inspect

You should get something like this

=> 
#<GitlabSettings::Options:0x0000757198790b38
 @options=
  {"enabled"=>false,
   "id"=>nil,
   "database"=>
    #<GitlabSettings::Options:0x0000757198790098
     @options={"skip_sequence_alteration"=>false}>,
   "topology_service_client"=>
    #<GitlabSettings::Options:0x00007571987af498
     @options=
      {"address"=>"topology-service.gitlab.example.com:443",
       "ca_file"=>"/home/git/gitlab/config/topology-service-ca.pem",
       "certificate_file"=>"/home/git/gitlab/config/topology-service-cert.pem",
       "private_key_file"=>"/home/git/gitlab/config/topology-service-key.pem"}>}>

Validating the over-ridden values to enable Cells

Edit this file /etc/gitlab/gitlab.rb and have this config for Cells. You can uncomment the lines and change the values accordingly. Make sure you set both the cell.id and topology_service.enabled is set to true.

#### Cells                                                           
 gitlab_rails['cell'] = {
   enabled: true,
   id: 1,
   database: {                      
     skip_sequence_alteration: false 
   },
   topology_service_client: {
     address: 'topology-service.gitlab.example.com:443',                 
     ca_file: '/home/git/gitlab/config/topology-service-ca.pem', 
     certificate_file: '/home/git/gitlab/config/topology-service-cert.pem', 
     private_key_file: '/home/git/gitlab/config/topology-service-key.pem'   
   }                                                                        
 }

Run:

gitlab-ctl reconfigure
gitlab-rails console
puts Settings.cell.inspect

You should get something like

=> 
#<GitlabSettings::Options:0x000072743a9924a8
 @options=
  {"enabled"=>true,
   "id"=>1,
   "database"=>
    #<GitlabSettings::Options:0x000072743a992688
     @options={"skip_sequence_alteration"=>false}>,
   "topology_service_client"=>
    #<GitlabSettings::Options:0x000072743a9925c0
     @options=
      {"address"=>"topology-service.gitlab.example.com:443",
       "ca_file"=>"/home/git/gitlab/config/topology-service-ca.pem",
       "certificate_file"=>"/home/git/gitlab/config/topology-service-cert.pem",
       "private_key_file"=>"/home/git/gitlab/config/topology-service-key.pem"}>}>

Related issues

gitlab#487059 (closed)

Checklist

See Definition of done.

For anything in this list which will not be completed, please provide a reason in the MR discussion.

Required

• MR title and description are up to date, accurate, and descriptive.
• MR targeting the appropriate branch.
• Latest Merge Result pipeline is green.
• When ready for review, MR is labeled workflowready for review per the Distribution MR workflow.

For GitLab team members

If you don't have access to this, the reviewer should trigger these jobs for you during the review process.

• The manual Trigger:ee-package jobs have a green pipeline running against latest commit.
• If config/software or config/patches directories are changed, make sure the build-package-on-all-os job within the Trigger:ee-package downstream pipeline succeeded.
• If you are changing anything SSL related, then the Trigger:package:fips manual job within the Trigger:ee-package downstream pipeline must succeed.
• If CI configuration is changed, the branch must be pushed to dev.gitlab.org to confirm regular branch builds aren't broken.

Expected (please provide an explanation if not completing)

• Test plan indicating conditions for success has been posted and passes.
• Documentation created/updated.
• Tests added.
• Integration tests added to GitLab QA.
• Equivalent MR/issue for the GitLab Chart opened.
• Validate potential values for new configuration settings. Formats such as integer 10, duration 10s, URI scheme://user:passwd@host:port may require quotation or other special handling when rendered in a template and written to a configuration file.