diff options
Diffstat (limited to 'doc/administration/job_artifacts.md')
-rw-r--r-- | doc/administration/job_artifacts.md | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/doc/administration/job_artifacts.md b/doc/administration/job_artifacts.md index 6f927d8f920..cc1d744d73b 100644 --- a/doc/administration/job_artifacts.md +++ b/doc/administration/job_artifacts.md @@ -21,7 +21,7 @@ To disable artifacts site-wide, follow the steps below. gitlab_rails['artifacts_enabled'] = false ``` -1. Save the file and [reconfigure GitLab][] for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. **In installations from source:** @@ -32,7 +32,7 @@ To disable artifacts site-wide, follow the steps below. enabled: false ``` -1. Save the file and [restart GitLab][] for the changes to take effect. +1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. ## Storing job artifacts @@ -57,7 +57,7 @@ _The artifacts are stored by default in gitlab_rails['artifacts_path'] = "/mnt/storage/artifacts" ``` -1. Save the file and [reconfigure GitLab][] for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. **In installations from source:** @@ -73,7 +73,7 @@ _The artifacts are stored by default in path: /mnt/storage/artifacts ``` -1. Save the file and [restart GitLab][] for the changes to take effect. +1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. ### Using object storage @@ -153,7 +153,7 @@ _The artifacts are stored by default in } ``` -1. Save the file and [reconfigure GitLab][] for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. Migrate any existing local artifacts to the object storage: ```shell @@ -186,7 +186,7 @@ _The artifacts are stored by default in region: eu-central-1 ``` -1. Save the file and [restart GitLab][] for the changes to take effect. +1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. 1. Migrate any existing local artifacts to the object storage: ```shell @@ -205,13 +205,13 @@ by the `gitlab:artifacts:migrate` script. In order to migrate back to local storage: 1. Set both `direct_upload` and `background_upload` to false in `gitlab.rb`, under the artifacts object storage settings. -1. [reconfigure GitLab][]. +1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure). 1. Run `gitlab-rake gitlab:artifacts:migrate_to_local`. 1. Disable object_storage for artifacts in `gitlab.rb`: - Set `gitlab_rails['artifacts_object_store_enabled'] = false`. - Comment out all other `artifacts_object_store` settings, including the entire `artifacts_object_store_connection` section, including the closing `}`. -1. [reconfigure GitLab][]. +1. [Reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure). ## Expiring artifacts @@ -231,7 +231,7 @@ steps below. gitlab_rails['expire_build_artifacts_worker_cron'] = "50 * * * *" ``` -1. Save the file and [reconfigure GitLab][] for the changes to take effect. +1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. **In installations from source:** @@ -243,7 +243,7 @@ steps below. cron: "50 * * * *" ``` -1. Save the file and [restart GitLab][] for the changes to take effect. +1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. ## Validation for dependencies @@ -295,7 +295,7 @@ and [projects APIs](../api/projects.md). ## Implementation details When GitLab receives an artifacts archive, an archive metadata file is also -generated by [GitLab Workhorse]. This metadata file describes all the entries +generated by [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse). This metadata file describes all the entries that are located in the artifacts archive itself. The metadata file is in a binary format, with additional GZIP compression. @@ -304,14 +304,10 @@ and disk I/O. It instead inspects the metadata file which contains all the relevant information. This is especially important when there is a lot of artifacts, or an archive is a very large file. -When clicking on a specific file, [GitLab Workhorse] extracts it +When clicking on a specific file, [GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse) extracts it from the archive and the download begins. This implementation saves space, memory and disk I/O. -[reconfigure gitlab]: restart_gitlab.md#omnibus-gitlab-reconfigure "How to reconfigure Omnibus GitLab" -[restart gitlab]: restart_gitlab.md#installations-from-source "How to restart GitLab" -[gitlab workhorse]: https://gitlab.com/gitlab-org/gitlab-workhorse "GitLab Workhorse repository" - ## Troubleshooting ### Job artifacts using too much disk space |