Clarify / revise gitlab-runner SIGQUIT config
What does this MR do?
This MR aims to add clarity to our instructions on setting up gitlab-runner to perform graceful shutdowns via systemd.
Specifically:
- Add a step within the gitlab-runner graceful stop guidance that advises to reload systemd so that the altered configuration files are applied.
- Specify a valid
TimeoutStopSec
example. Previously this was set to__REDACTED__
, presumably in reference to the config example being pulled from a real world example, and the true value being redacted. It would be better to simply provide a valid working example that systemd can work with, as some users are likely to copy the values out of this verbatim, and__REDACTED__
is not valid. I've simply choseninfinity
in this case where this seems to match the overall intention of the guidance here.
Related issues
This MR is being raised in reaction to a SaaS Premium customer having reached out to the support team via a support ticket, after having faced some difficulties implementing the gitlab-runner graceful shutdown configuration per our documentation.
- Zendesk (internal use only)
- Salesforce (internal use only)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"
~"backend"
~"type::bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. -
Technical writer review items: -
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. -
If relevant to this MR, ensure content topic type principles are in use, including: -
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. -
If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.