Merge branch 'registry-add-notifications-maxretries' into 'master'

Add maxretries config for registry notifications

See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7550

Merged-by: Jaime Martinez <jmartinez@gitlab.com>
Approved-by: Vishal Patel <vpatel@gitlab.com>
Reviewed-by: Vishal Patel <vpatel@gitlab.com>

config/software/registry.rb

@@ -19,7 +19,7 @@
 require "#{Omnibus::Config.project_root}/lib/gitlab/version"
 
 name 'registry'
-version = Gitlab::Version.new('registry', 'v3.93.0-gitlab')
+version = Gitlab::Version.new('registry', 'v4.0.0-gitlab')
 
 default_version version.print(false)
 display_version version.print(false).delete_suffix('-gitlab')

files/gitlab-config-template/gitlab.rb.template

@@ -1048,7 +1048,8 @@ external_url 'GENERATED_EXTERNAL_URL'
 #     'name' => 'test_endpoint',
 #     'url' => 'https://gitlab.example.com/notify2',
 #     'timeout' => '500ms',
-#     'threshold' => 5,
+#     'threshold' => 5, # DEPRECATED: use maxretries instead https://gitlab.com/gitlab-org/container-registry/-/issues/1243
+#     'maxretries' => 5,
 #     'backoff' => '1s',
 #     'headers' => {
 #       "Authorization" => ["AUTHORIZATION_EXAMPLE_TOKEN"]
@@ -1058,6 +1059,7 @@ external_url 'GENERATED_EXTERNAL_URL'
 ### Default registry notifications
 # registry['default_notifications_timeout'] = "500ms"
 # registry['default_notifications_threshold'] = 5
+# registry['default_notifications_maxretries'] = 5
 # registry['default_notifications_backoff'] = "1s"
 # registry['default_notifications_headers'] = {}
 

files/gitlab-cookbooks/gitlab/libraries/registry.rb

@@ -137,6 +137,7 @@ module Registry
       # Use the registry defaults configured by the user but use the defaults from gitlab if they were not set
       user_configuration['default_notifications_timeout'] ||= gitlab_configuration['default_notifications_timeout']
       user_configuration['default_notifications_threshold'] ||= gitlab_configuration['default_notifications_threshold']
+      user_configuration['default_notifications_maxretries'] ||= gitlab_configuration['default_notifications_maxretries']
       user_configuration['default_notifications_backoff'] ||=  gitlab_configuration['default_notifications_backoff']
       user_configuration['default_notifications_headers'] ||=  gitlab_configuration['default_notifications_headers']
 
@@ -144,6 +145,7 @@ module Registry
         # Get the values from default if they are not set
         endpoint['timeout'] ||= user_configuration['default_notifications_timeout']
         endpoint['threshold'] ||= user_configuration['default_notifications_threshold']
+        endpoint['maxretries'] ||= user_configuration['default_notifications_maxretries']
         endpoint['backoff'] ||= user_configuration['default_notifications_backoff']
 
         # And merge the default headers with the ones specific to this endpoint

files/gitlab-cookbooks/package/libraries/deprecations.rb

@@ -361,6 +361,12 @@ module Gitlab
             deprecation: '16.10',
             removal: '17.0',
             note: "`omnibus_gitconfig` will be removed in GitLab 17.0. For details and migration instructions, please see: https://docs.gitlab.com/ee/update/versions/gitlab_16_changes.html#gitlabomnibus_gitconfig-deprecation"
+          },
+          {
+            config_keys: %w(registry default_notifications_threshold),
+            deprecation: '17.0',
+            removal: '18.0',
+            note: "Starting with GitLab 18.0, `registry['default_notifications_threshold'] will be removed. Please use `default_notifications_maxretries` instead https://gitlab.com/gitlab-org/container-registry/-/issues/1243."
           }
         ]
 
@@ -606,6 +612,13 @@ module Gitlab
         EOS
         messages += deprecate_only_if_value(incoming_version, existing_config, type, ['monitoring', 'grafana'], 'enable', true, '16.0', '16.3', note: grafana_note)
 
+        notifications_threshold_note = <<~EOS
+          Starting with GitLab 18.0, `registry['notifications']['endpoint']['threshold'] will be removed.
+          Please use `maxretries` instead https://gitlab.com/gitlab-org/container-registry/-/issues/1243.  
+        EOS
+
+        messages += deprecate_only_if_value(incoming_version, existing_config, type, ['registry', 'notifications'],'endpoint','threshold',17.0, 18.0, note: notifications_threshold_note)
+
         messages
       end
 

files/gitlab-cookbooks/registry/attributes/default.rb

@@ -45,5 +45,6 @@ default['registry']['gc'] = nil
 default['registry']['notifications'] = nil
 default['registry']['default_notifications_timeout'] = "500ms"
 default['registry']['default_notifications_threshold'] = 5
+default['registry']['default_notifications_maxretries'] = 5
 default['registry']['default_notifications_backoff'] = "1s"
 default['registry']['default_notifications_headers'] = {}

spec/chef/cookbooks/registry/recipes/registry_spec.rb

@@ -378,6 +378,7 @@ RSpec.describe 'registry' do
             ],
             default_notifications_timeout: '5000ms',
             default_notifications_threshold: 10,
+            default_notifications_maxretries: 5,
             default_notifications_backoff: '50s',
             default_notifications_headers: {
               "Authorization" => %w(AUTHORIZATION_EXAMPLE_TOKEN1 AUTHORIZATION_EXAMPLE_TOKEN2)
@@ -395,6 +396,8 @@ RSpec.describe 'registry' do
           .with_content(/"timeout":"5000ms"/)
         expect(chef_run).to render_file('/var/opt/gitlab/registry/config.yml')
           .with_content(/"threshold":10/)
+        expect(chef_run).to render_file('/var/opt/gitlab/registry/config.yml')
+          .with_content(/"maxretries":5/)
         expect(chef_run).to render_file('/var/opt/gitlab/registry/config.yml')
           .with_content(/"backoff":"50s"/)
       end