Skip to content

Support specifying encrypted secrets path for Redis

Balasankar 'Balu' C requested to merge 6275-support-redis-encrypted-secrets into master

What does this MR do?

Support specifying encrypted secrets path for Redis. Depends on gitlab!136002 (merged)

Testing

  1. Spin up a GitLab instance using package/image from this MR.

  2. Run reconfigure and get a functional instance

  3. Edit /etc/gitlab/gitlab.rb and add the following line to it

    redis['password'] = 'foobar'
  4. Run reconfigure so that the changes take effect.

  5. Run the following command to ensure that Rails can't talk to Redis

    $ gitlab-rails runner -e production 'redis = Redis.new(Gitlab::Redis::Cache.params); puts redis.info["redis_version"]'
    /opt/gitlab/embedded/lib/ruby/gems/3.0.0/gems/redis-4.8.0/lib/redis/client.rb:162:in `call': NOAUTH Authentication required. (Redis::CommandError)
  6. Run the following command so that the secret is written (you can also run just the rake task and add the content to it instead of piping. Make sure EDITOR variable is set)

    $ echo "password: 'foobar'" | gitlab-rake gitlab:redis:secret:write
    File encrypted and saved.
  7. Run the following command again and see that Rails can now talk to Redis

    $ gitlab-rails runner -e production 'redis = Redis.new(Gitlab::Redis::Cache.params); puts redis.info["redis_version"]'
    7.0.14

Related issues

Closes #6275 (closed)

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 João Alexandre Cunha

Merge request reports

Loading