Skip to content

feat: add Redis ACL username support in cache

Stan Hu requested to merge sh-add-redis-username-support into master

What does this MR do?

!1643 (merged) added support for Redis usernames, but it did not configure this for the cache.

If the Redis default user were disabled, previously the registry would not be able to talk to the cache. Now the username can be specified.

Related to omnibus-gitlab#8574

Testing

  1. Create a /tmp/redis.conf with:
port 9999
user default off
user myuser on >somepassword allcommands allkeys
  1. Run redis-server /tmp/redis.conf.

  2. Then in the config.toml, add the redis block:

redis:
  cache:
    enabled: true
    addr: localhost:9999
    username: myuser
    password: somepassword
  1. Compile this branch and run /bin/registry serve config.yml.
  2. You should see this log entry:
{"go_version":"go1.22.1","instance_id":"891bff48-3d0b-4e56-ab79-fd2727459fd7","level":"info","msg":"redis cache configured successfully","time":"2024-08-09T13:48:40.948-07:00","version":"v4.7.0-gitlab-29-g4dfd6b21.m"}

Author checklist

  • Feature flags
    • Added feature flag:
    • This feature does not require a feature flag
  • I added unit tests or they are not required
  • I added documentation (or it's not required)
  • I followed code review guidelines
  • I followed Go Style guidelines
  • For database changes including schema migrations:
    • Manually run up and down migrations in a postgres.ai production database clone and post a screenshot of the result here.
    • If adding new queries, extract a query plan from postgres.ai and post the link here. If changing existing queries, also extract a query plan for the current version for comparison.
      • I do not have access to postgres.ai and have made a comment on this MR asking for these to be run on my behalf.
    • Do not include code that depends on the schema migrations in the same commit. Split the MR into two or more.
  • Ensured this change is safe to deploy to individual stages in the same environment (cny -> prod). State-related changes can be troublesome due to having parts of the fleet processing (possibly related) requests in different ways.

Reviewer checklist

  • Ensure the commit and MR tittle are still accurate.
  • If the change contains a breaking change, apply the breaking change label.
  • If the change is considered high risk, apply the label high-risk-change
  • Identify if the change can be rolled back safely. (note: all other reasons for not being able to rollback will be sufficiently captured by major version changes).

If the MR introduces database schema migrations:

  • Ensure the commit and MR tittle start with fix:, feat:, or perf: so that the change appears on the Changelog
If the changes cannot be rolled back follow these steps:
  • If not, apply the label cannot-rollback.
  • Add a section to the MR description that includes the following details:
    • The reasoning behind why a release containing the presented MR can not be rolled back (e.g. schema migrations or changes to the FS structure)
    • Detailed steps to revert/disable a feature introduced by the same change where a migration cannot be rolled back. (note: ideally MRs containing schema migrations should not contain feature changes.)
    • Ensure this MR does not add code that depends on these changes that cannot be rolled back.
Edited by Stan Hu

Merge request reports

Loading