summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJacob Vosmaer <contact@jacobvosmaer.nl>2016-04-04 17:23:43 +0200
committerJacob Vosmaer <contact@jacobvosmaer.nl>2016-04-04 17:23:43 +0200
commitbf9526739b5c90790907c1d8b9410dd339e3d395 (patch)
treecce5be3bbb11b2baf2e5fce5c2e49339e552a7ca /doc
parent213ee62469c6518af8423f00fb902b7665d61204 (diff)
downloadgitlab-ce-bf9526739b5c90790907c1d8b9410dd339e3d395.tar.gz
Rebase repo check MR
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/repo_checks.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/administration/repo_checks.md b/doc/administration/repo_checks.md
new file mode 100644
index 00000000000..9c2c01594e8
--- /dev/null
+++ b/doc/administration/repo_checks.md
@@ -0,0 +1,39 @@
+# Repo checks
+
+_**Note:** This feature was [introduced][ce-3232] in GitLab 8.7_
+
+---
+
+Git has a built-in mechanism [git fsck][git-fsck] to verify the
+integrity of all data commited to a repository. GitLab administrators can
+trigger such a check for a project via the admin panel. The checks run
+asynchronously so it may take a few minutes before the check result is
+visible on the project admin page. If the checks failed you can see their
+output on the admin log page under 'repocheck.log'.
+
+## Periodical checks
+
+GitLab periodically runs a repo check on all project repositories and
+wiki repositories in order to detect data corruption problems. A
+project will be checked no more than once per week. If any projects
+fail their repo checks all GitLab administrators will receive an email
+notification of the situation. This notification is sent out no more
+than once a day.
+
+
+## What to do if a check failed
+
+If the repo check fails for some repository you should look up the error
+in repocheck.log (in the admin panel or on disk; see
+`/var/log/gitlab/gitlab-rails` for Omnibus installations or
+`/home/git/gitlab/log` for installations from source). Once you have
+resolved the issue use the admin panel to trigger a new repo check on
+the project. This will clear the 'check failed' state.
+
+If for some reason the periodical repo check caused a lot of false
+alarms you can choose to clear ALL repo check states from the admin
+project index page.
+
+---
+[ce-3232]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3232 "Auto git fsck"
+[git-fsck]: https://www.kernel.org/pub/software/scm/git/docs/git-fsck.html "git fsck documentation" \ No newline at end of file