diff options
Diffstat (limited to 'doc/raketasks/cleanup.md')
| -rw-r--r-- | doc/raketasks/cleanup.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/raketasks/cleanup.md b/doc/raketasks/cleanup.md index 00a3e9196e2..0c184aa0075 100644 --- a/doc/raketasks/cleanup.md +++ b/doc/raketasks/cleanup.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Clean up **(CORE ONLY)** @@ -12,13 +12,13 @@ GitLab provides Rake tasks for cleaning up GitLab instances. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36628) in GitLab 12.10. -DANGER: **Warning:** +WARNING: Do not run this within 12 hours of a GitLab upgrade. This is to ensure that all background migrations have finished, which otherwise may lead to data loss. When you remove LFS files from a repository's history, they become orphaned and continue to consume disk space. With this Rake task, you can remove invalid references from the database, which -will allow garbage collection of LFS files. +allows garbage collection of LFS files. For example: @@ -44,7 +44,7 @@ By default, this task does not delete anything but shows how many file reference delete. Run the command with `DRY_RUN=false` if you actually want to delete the references. You can also use `LIMIT={number}` parameter to limit the number of deleted references. -Note that this Rake task only removes the references to LFS files. Unreferenced LFS files will be garbage-collected +Note that this Rake task only removes the references to LFS files. Unreferenced LFS files are garbage-collected later (once a day). If you need to garbage collect them immediately, run `rake gitlab:cleanup:orphan_lfs_files` described below. @@ -148,8 +148,8 @@ I, [2018-08-02T10:26:47.764356 #45087] INFO -- : Moved to lost and found: @hash > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29681) in GitLab 12.1. > - [`ionice` support fixed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28023) in GitLab 12.10. -NOTE: **Note:** -These commands will not work for artifacts stored on +NOTE: +These commands don't work for artifacts stored on [object storage](../administration/object_storage.md). When you notice there are more job artifacts files and/or directories on disk than there @@ -179,10 +179,10 @@ You can also limit the number of files to delete with `LIMIT`: sudo gitlab-rake gitlab:cleanup:orphan_job_artifact_files LIMIT=100 ``` -This will only delete up to 100 files from disk. You can use this to -delete a small set for testing purposes. +This deletes only up to 100 files from disk. You can use this to delete a small +set for testing purposes. -If you provide `DEBUG=1`, you'll see the full path of every file that +Providing `DEBUG=1` displays the full path of every file that is detected as being an orphan. If `ionice` is installed, the tasks uses it to ensure the command is |