Skip to content

Do not restart gitlab-kas service if stopped

Andrew Patterson requested to merge 8117-no-restart-for-stopped-service into master

Summary

Do not restart gitlab runit services if stopped

A gitlab runit service should not be restarted in chef cookbooks if it has been stopped with the gitlab-ctl stop command.

Related issues

Test plan

  • Make sure no restart for stopped gitlab-kas service

    • Prep

      1. gitlab-ctl reconfigure
      2. gitlab-ctl stop
    • Remove /etc/gitlab/gitlab-secrets.json

      1. rm -f /etc/gitlab/gitlab-secrets.json
      2. gitlab-ctl reconfigure 2>&1 | tee /tmp/reconfigure.log
      3. Check log for runit_service['gitlab-kas'] action restart (should not be present)
    • Remove /var/opt/gitlab/gitlab-kas/VERSION

      1. rm -f /var/opt/gitlab/gitlab-kas/VERSION
      2. gitlab-ctl reconfigure 2>&1 | tee /tmp/reconfigure.log
      3. Check log for runit_service['gitlab-kas'] action restart (should not be present)
    • Remove /var/opt/gitlab/gitlab-kas/authentication_secret_file

      1. rm -f /var/opt/gitlab/gitlab-kas/authentication_secret_file
      2. gitlab-ctl reconfigure 2>&1 | tee /tmp/reconfigure.log
      3. Check log for runit_service['gitlab-kas'] action restart (should not be present)
    • Remove /var/opt/gitlab/gitlab-kas/private_api_authentication_secret_file

      1. rm -f /var/opt/gitlab/gitlab-kas/private_api_authentication_secret_file
      2. gitlab-ctl reconfigure 2>&1 | tee /tmp/reconfigure.log
      3. Check log for runit_service['gitlab-kas'] action restart (should not be present)
    • Remove /var/opt/gitlab/gitlab-kas/gitlab-kas-config.yml

      1. rm -f /var/opt/gitlab/gitlab-kas/gitlab-kas-config.yml
      2. gitlab-ctl reconfigure 2>&1 | tee /tmp/reconfigure.log
      3. Check log for runit_service['gitlab-kas'] action restart (should not be present)
  • Make sure no errors during repeated reconfigures:

    Prep

    gitlab-ctl reconfigure
    gitlab-ctl stop

    Run the following at least 10 times:

    1. Run reproducer command.
    sudo rm -f /tmp/reconfigure.log && sudo rm -f /etc/gitlab/gitlab-secrets.json && sudo gitlab-ctl reconfigure 2>&1 | tee /tmp/reconfigure.log
    1. Check /tmp/reconfigure.log for errors in gitlab-kas service.

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.

Closes #8117 (closed)

Edited by João Alexandre Cunha

Merge request reports