diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2022-08-10 11:39:17 +0300 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2022-08-10 11:47:00 +0300 |
| commit | d75ac9b2826fb0425e1e5dd343fa58aa75750d07 (patch) | |
| tree | 6224d2c383c9bd96114b2dc92681722a213ef6c3 | |
| parent | 4401f81d71ad1f4e57e74ee4f277d2f05fa9fa48 (diff) | |
Add initial troubleshooting docaxil-doc-troubleshooting
| -rw-r--r-- | doc/troubleshooting.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md new file mode 100644 index 00000000..3b860462 --- /dev/null +++ b/doc/troubleshooting.md @@ -0,0 +1,37 @@ +# Troubleshooting + +## How to debug failed jobs + +The [`#docs-site-changes`](https://gitlab.slack.com/archives/C011D3TA610) Slack +channel gets notifications when new MRs are opened, approved, and merged into +`main`. It also gets notifications for all failed pipelines in `main`. + +In general: + +- Failed jobs are retried two more times if they fail (they run three time in total). + Before panicking about `main` being broken, navigate to the + [Pipelines page](https://gitlab.com/gitlab-org/gitlab-docs/-/pipelines) and see if + the latest pipeline is green. If this the case, you can ignore the failed + pipeline. If not, check the failed job to further troubleshoot the failure. +- When the job fails before it reaches the **Getting source from Git repository** step, + it most likely is an infrastructure, and in most cases intermitent problem. + Wait for all three tries before jumping into pinging people and debugging to + find the root cause. For example, see this job <https://gitlab.com/gitlab-org/gitlab/-/jobs/2834890543>. + + All build and test jobs use the Docker shared runners. Before the job reaches + to the steps defined in `.gitlab-ci.yml`, you'll see something like the following: + + ```plaintext + Running with gitlab-runner 15.3.0~beta.42.gdb7789ca (db7789ca) + on green-2.shared-gitlab-org.runners-manager.gitlab.com/default 8zCxmpPt + Resolving secrets + Preparing the "docker+machine" executor + Using Docker executor with image registry.gitlab.com/<some-image> + Authenticating with credentials from job payload (GitLab Registry) + Pulling docker image registry.gitlab.com/<some-image> ... + Using docker image sha256:2d1abf4a01d12c8c710daf827b2183fde85d63110cdf868348ceebfbeb1eeb95 for registry.gitlab.com/<some-image> with digest registry.gitlab.com/<some-image>@sha256:5e5324481728010c0a699787a5aab0245a71fcbddb214d81bebc408c7b2d7980 ... + Preparing environment + Running on runner-8zcxmppt-project-278964-concurrent-0 via runner-8zcxmppt-shared-gitlab-org-1660071123-dc709223... + Getting source from Git repository + ... + ``` |