Skip to content

redis: Fix password auth with UNIX domain sockets

Stan Hu requested to merge sh-fix-unix-redis-with-password into master

What does this MR do?

Previously if a Redis instance listened on a UNIX socket but a password were set, GitLab Rails would not be able to authenticate. This occurred because the UNIX URL doesn't contain a password.

Both Ruby [1] and Go [2] Redis clients support URLs in the form:

unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>

Related issues

Relates to work started in !2194 (closed)

Testing

As mentioned in https://docs.gitlab.com/omnibus/settings/redis.html, set in /etc/gitlab/gitlab.rb:

gitlab_rails['redis_password'] = 'your-password-here'
redis['password'] = 'your-password-here'

Previously, GitLab Rails would complain:

root@012223f5c191:/var/log/gitlab/gitlab-rails# grep NOAUTH production.log | head
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):
Redis::CommandError (NOAUTH Authentication required. (unix:///var/opt/gitlab/redis/redis.socket)):

Workhorse will complain:

root@012223f5c191:/var/log/gitlab/gitlab-workhorse# grep NOAUTH current | head
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}
{"error":"keywatcher: pubsub receive: NOAUTH Authentication required.","level":"error","msg":"","time":"2024-04-27T07:05:55Z"}

With this change, the errors go away, and GitLab functions.

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 "~workflow::ready 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.
Edited by Stan Hu

Merge request reports