Skip to content

Draft: Use bundler to isolate gitlab-ctl gems

Stan Hu requested to merge sh-use-bundler-gitlab-ctl into master

What does this MR do?

Previously when gitlab-ctl ran, whatever gems installed in the default Ruby path could be loaded. However, this meant an upgrade in GitLab Rails to a gem like parser could be loaded by gitlab-ctl. To avoid this, we need to:

  1. Put omnibus-ctl into the bundler omnibus-gitlab-gems Gemfile.
  2. Since omnibus-ctl is built from a Git repository, bundler installs this gem into a separate bundler/gems directory. In order to load this gem, gitlab-ctl has to preface the call to omnibus-ctl with bundle exec.

This means at startup gitlab-ctl will load all the gems specified in the Gemfile instead of lazily loading them via require, but this ensures that only the gems specified in the omnibus-gitlab-gems Gemfile.lock will be used.

Related issues

Part of #8368

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