Skip to content

Add runner execution flow diagram

Martin Brümmer requested to merge doc-runner-execution-flow into master

What does this MR do?

This MR introduces an additional section in the runner docs, providing an execution flow sequence diagram on the interaction between GitLab, GitLab Runner and the executors, including the usage of the individual relevant tokens (runner registration token, authentication token and job token).

I was unable to find a more specific runner docs page this section could go in. I figured it makes sense to have a high-level overview on the index page.

Related issues

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports