Refactor Cell Configuration

Addressing: #513075
Changelog: other

config/gitlab.yml.example

@@ -1279,17 +1279,16 @@ production: &base
     # Default is '.gitlab_workhorse_secret' relative to Rails.root (i.e. root of the GitLab app).
     # secret_file: /home/git/gitlab/.gitlab_workhorse_secret
 
-  topology_service:
-    # enabled: false
-    # 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
-
   cell:
-    # id: null
-    # name: null
-    # skip_sequence_alteration: false
+     id: null
+     database:
+       skip_sequence_alteration: false
+     topology_service:
+       enabled: false
+    #  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
 
   gitlab_kas:
     # enabled: true

config/initializers/1_settings.rb

@@ -1046,23 +1046,19 @@
 Settings['workhorse'] ||= {}
 Settings.workhorse['secret_file'] ||= Rails.root.join('.gitlab_workhorse_secret')
 
-#
-# Topology Service
-#
-Settings['topology_service'] ||= {}
-Settings.topology_service['enabled'] ||= false
-Settings.topology_service['address'] ||= 'topology-service.gitlab.example.com:443'
-Settings.topology_service['ca_file'] ||= '/home/git/gitlab/config/topology-service-ca.pem'
-Settings.topology_service['certificate_file'] ||= '/home/git/gitlab/config/topology-service-cert.pem'
-Settings.topology_service['private_key_file'] ||= '/home/git/gitlab/config/topology-service-key.pem'
-
 #
 # Cells
 #
 Settings['cell'] ||= {}
 Settings.cell['id'] ||= nil
-Settings.cell['name'] ||= nil
-Settings.cell['skip_sequence_alteration'] ||= false
+Settings.cell['database'] ||= {}
+Settings.cell.database['skip_sequence_alteration'] ||= false
+Settings.cell['topology_service'] ||= {}
+Settings.cell.topology_service['enabled'] ||= false
+Settings.cell.topology_service['address'] ||= 'topology-service.gitlab.example.com:443'
+Settings.cell.topology_service['ca_file'] ||= '/home/git/gitlab/config/topology-service-ca.pem'
+Settings.cell.topology_service['certificate_file'] ||= '/home/git/gitlab/config/topology-service-cert.pem'
+Settings.cell.topology_service['private_key_file'] ||= '/home/git/gitlab/config/topology-service-key.pem'
 
 #
 # GitLab KAS

config/initializers/topology_service.rb

-# frozen_string_literal: true
-
-topology_service_settings = Settings.topology_service
-return unless topology_service_settings.enabled
-
-# Configuring the Topology Service will be done here
-# Issue: https://gitlab.com/gitlab-org/gitlab/-/issues/451052
-# The code should look like when configuring
-# the topology service client.
-
-# address = topology_service_settings.address
-# cell_settings = Settings.cell # will be used for the topology service requests metadata
-# See this draft MR for an example:
-# https://gitlab.com/gitlab-org/gitlab/-/merge_requests/146528/diffs
-#
-# claim_service = Gitlab::Cells::ClaimService::Stub.new(address, :this_channel_is_insecure)

config/initializers/validate_cell_config.rb

@@ -4,10 +4,10 @@
 
 ValidationError = Class.new(StandardError)
 
-if Gitlab.config.cell.id.present? && !Gitlab.config.topology_service.enabled
+if Gitlab.config.cell.id.present? && !Gitlab.config.cell.topology_service.enabled
   raise ValidationError, "Topology Service is not configured, but Cell ID is set"
 end
 
-if Gitlab.config.topology_service.enabled && Gitlab.config.cell.id.blank?
+if Gitlab.config.cell.topology_service.enabled && Gitlab.config.cell.id.blank?
   raise ValidationError, "Topology Service is enabled, but Cell ID is not set"
 end

config/settings.rb

@@ -181,11 +181,11 @@ def build_sidekiq_routing_rules(rules)
 
   # This method dictates whether the GitLab instance is part of a cells cluster
   def topology_service_enabled?
-    topology_service && topology_service.respond_to?(:enabled) && topology_service.enabled
+    cell.topology_service.enabled
   end
 
   def skip_sequence_alteration?
-    cell.respond_to?(:skip_sequence_alteration) && cell.skip_sequence_alteration
+    cell.database.respond_to?(:skip_sequence_alteration) && cell.database.skip_sequence_alteration
   end
 
   private

lib/gitlab/topology_service_client/base_service.rb

@@ -19,7 +19,9 @@ def client
       end
 
       def cell_name
-        @cell_name ||= Gitlab.config.cell.name
+        # This should be removed in https://gitlab.com/gitlab-org/cells/topology-service/-/issues/55
+        # then we should pass cell.id instead
+        @cell_name ||= "cell-#{Gitlab.config.cell.id}"
       end
 
       def service_credentials
@@ -28,7 +30,7 @@ def service_credentials
       end
 
       def topology_service_address
-        Gitlab.config.topology_service.address
+        Gitlab.config.cell.topology_service.address
       end
 
       def enabled?

spec/initializers/validate_cell_config_spec.rb

@@ -27,7 +27,7 @@
 
   context 'when topology service is correctly configured' do
     before do
-      stub_config(cell: { id: 1 }, topology_service: { enabled: true })
+      stub_config(cell: { id: 1, topology_service: { enabled: true } })
     end
 
     it 'does not raise exception' do
@@ -37,7 +37,7 @@
 
   context 'when topology service is not configured' do
     before do
-      stub_config(cell: { id: nil }, topology_service: { enabled: false })
+      stub_config(cell: { id: nil, topology_service: { enabled: false } })
     end
 
     it 'does not raise exception' do
@@ -48,7 +48,7 @@
   context 'when configuration is wrong' do
     context 'when only cell.id is configured' do
       before do
-        stub_config(cell: { id: 1 }, topology_service: { enabled: false })
+        stub_config(cell: { id: 1, topology_service: { enabled: false } })
       end
 
       it 'does not raise exception' do
@@ -60,7 +60,7 @@
 
     context 'when only topology service is enabled' do
       before do
-        stub_config(cell: { id: nil }, topology_service: { enabled: true })
+        stub_config(cell: { id: nil, topology_service: { enabled: true } })
       end
 
       it 'does not raise exception' do

spec/lib/gitlab/topology_service_client/base_service_spec.rb

@@ -8,7 +8,7 @@
   describe '#initialize' do
     context 'when topology service is disabled' do
       it 'raises an error when topology service is not enabled' do
-        expect(Gitlab.config.topology_service).to receive(:enabled).and_return(false)
+        expect(Gitlab.config.cell.topology_service).to receive(:enabled).and_return(false)
 
         expect { base_service }.to raise_error(NotImplementedError)
       end

spec/lib/gitlab/topology_service_client/cell_service_spec.rb

@@ -18,7 +18,7 @@
   describe '#get_cell_info' do
     context 'when topology service is disabled' do
       it 'raises an error when topology service is not enabled' do
-        expect(Gitlab.config.topology_service).to receive(:enabled).and_return(false)
+        expect(Gitlab.config.cell.topology_service).to receive(:enabled).and_return(false)
 
         expect { cell_service }.to raise_error(NotImplementedError)
       end
@@ -26,8 +26,8 @@
 
     context 'when topology service is enabled' do
       before do
-        allow(Gitlab.config.topology_service).to receive(:enabled).once.and_return(true)
-        allow(Gitlab.config.cell).to receive(:name).twice.and_return("cell-1")
+        allow(Gitlab.config.cell).to receive(:id).twice.and_return(1)
+        allow(Gitlab.config.cell.topology_service).to receive(:enabled).once.and_return(true)
       end
 
       it 'returns the cell information' do
@@ -57,8 +57,8 @@
   describe '#cell_sequence_range' do
     context 'when topology service is enabled' do
       before do
-        allow(Gitlab.config.topology_service).to receive(:enabled).once.and_return(true)
-        allow(Gitlab.config.cell).to receive(:name).twice.and_return("cell-1")
+        allow(Gitlab.config.cell).to receive(:id).twice.and_return(1)
+        allow(Gitlab.config.cell.topology_service).to receive(:enabled).once.and_return(true)
       end
 
       context 'when a cell exists in topology service' do