Add upgrade troubleshooting info to Runner docs
What does this MR do?
As per this issue discussion, adds troubleshooting info about when gitlab-runner 15.7.x and 15.8.x doesn't start if it lacks write permission for the directory containing the config.toml
file.
gitlab-runner 15.7.x and 15.8.x may refuse to start if it lacks write permission for the directory containing the config.toml file. It looks for a .runner_system_id file in that directory, and if it doesn't find a valid one, it will try to create a new one. In version 15.9, the issue was resolved by providing guidance to the user on how to manually create the file if necessary. Alternatively, users can temporarily allow file write permissions by running the gitlab-runner run command once. Once the .runner_system_id file is created, the permissions can be set back to read-only.
Since this error can occur in upgrades in multiple platforms (K8s, Docker, Windows), for now I'm adding this troubleshooting info to the GitLab Runner commands
page so that the installation docs for each platform can link here. This seems like currently the best location for this info.
Related issues
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.