Document Sidekiq health-check config keys
Before #345804 (closed) is done and since for SaaS we are already using the new settings keys for health-checks, we should document them publicly.
Together with #347509 (closed) we should prepare customers to use these new keys (if necessary) and describe how.
Omnibus
This might requires changes in multiple places.
We now have:
# Sidekiq metrics server defaults
default['gitlab']['sidekiq']['metrics_enabled'] = true
default['gitlab']['sidekiq']['exporter_log_enabled'] = false
default['gitlab']['sidekiq']['listen_address'] = "127.0.0.1"
default['gitlab']['sidekiq']['listen_port'] = 8082
and
# Sidekiq health-check server defaults
default['gitlab']['sidekiq']['health_checks_enabled'] = nil
default['gitlab']['sidekiq']['health_checks_log_enabled'] = nil
default['gitlab']['sidekiq']['health_checks_listen_address'] = nil
default['gitlab']['sidekiq']['health_checks_listen_port'] = nil
We should explain the difference between the two, and when they should be used. Configuring health_checks
in Omnibus is only necessary if there is something that actually probes them.
https://docs.gitlab.com/ee/administration/sidekiq.html
Links:
- https://gitlab.com/gitlab-org/gitlab/blob/97ebfd166ebba32f037e2bdc0947d65780dca65e/doc/administration/sidekiq.md
- We have https://gitlab.com/gitlab-org/gitlab/blob/ed5a5dfbd22cae46ab9d002c385cace713fe07ff/doc/user/admin_area/monitoring/health_check.md for Puma; do we have something like it for Sidekiq, and if not, should we?
Charts
We need to document the new setting in the sidekiq chart values:
health_checks:
enabled: true
port: 1234
https://docs.gitlab.com/charts/charts/gitlab/sidekiq
Links:
- https://gitlab.com/gitlab-org/charts/gitlab/blob/f94968b4bef32446b38c2033364107d1cff6e1bb/doc/charts/gitlab/sidekiq/index.md
- https://gitlab.com/gitlab-org/charts/gitlab/blob/72e2f65429a5629cdb3d63e1c500298d3d809501/charts/gitlab/charts/sidekiq/values.yaml#L54
- https://gitlab.com/gitlab-org/charts/gitlab/blob/72e2f65429a5629cdb3d63e1c500298d3d809501/charts/gitlab/charts/sidekiq/templates/deployment.yaml#L250
Edited by Matthias Käppler