Add missing runner variables to predefined list
What does this MR do?
While reviewing !81042 (merged) that added CI_SERVER_TLS_CA_FILE
to the predefined variable, I found more variables that did not seem to be documented. In total, we have these three:
Variable | GitLab | Runner | Description |
---|---|---|---|
CI_SERVER_TLS_CA_FILE |
all | all | File containing the TLS CA certificate to verify the GitLab server. |
CI_SERVER_TLS_CERT_FILE |
all | all | File containing the self-signed TLS certificate to verify the GitLab server. |
CI_SERVER_TLS_KEY_FILE |
all | all | File containing the TLS key to verify the GitLab server. |
There are some references to these in the runner code here:
- https://gitlab.com/gitlab-org/gitlab-runner/-/blob/33e59cb04fcfed1857cb8a2bfc295579ff38febb/helpers/tls/consts.go
- https://gitlab.com/gitlab-org/gitlab-runner/-/blob/33e59cb04fcfed1857cb8a2bfc295579ff38febb/common/config.go#L737-L739
After discussions with engineers (!83972 (comment 922764911)), it seems these variables are not predefined, and likely need to be documented as runner configuration variables in a separate place. For now, as an MVC, let's remove the incorrect entry (CI_SERVER_TLS_CA_FILE
) from the predefined variables table (it's not a predefined variable).
Related issues
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are 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.
Review 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 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. - 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 reviews above. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.