diff options
Diffstat (limited to 'doc/administration/raketasks/maintenance.md')
| -rw-r--r-- | doc/administration/raketasks/maintenance.md | 56 |
1 files changed, 23 insertions, 33 deletions
diff --git a/doc/administration/raketasks/maintenance.md b/doc/administration/raketasks/maintenance.md index c79a1aa6ba1..eee68c0da0a 100644 --- a/doc/administration/raketasks/maintenance.md +++ b/doc/administration/raketasks/maintenance.md @@ -1,8 +1,11 @@ -# Maintenance Rake Tasks +# Maintenance Rake tasks **(CORE ONLY)** -## Gather information about GitLab and the system it runs on +GitLab provides Rake tasks for general maintenance. -This command gathers information about your GitLab installation and the System it runs on. These may be useful when asking for help or reporting issues. +## Gather GitLab and system information + +This command gathers information about your GitLab installation and the system it runs on. +These may be useful when asking for help or reporting issues. **Omnibus Installation** @@ -50,20 +53,23 @@ Git: /usr/bin/git ## Check GitLab configuration -Runs the following Rake tasks: +The `gitlab:check` Rake task runs the following Rake tasks: - `gitlab:gitlab_shell:check` - `gitlab:gitaly:check` - `gitlab:sidekiq:check` - `gitlab:app:check` -It will check that each component was set up according to the installation guide and suggest fixes for issues found. -This command must be run from your app server and will not work correctly on component servers like [Gitaly](../gitaly/index.md#running-gitaly-on-its-own-server). +It will check that each component was set up according to the installation guide and suggest fixes +for issues found. This command must be run from your application server and will not work correctly on +component servers like [Gitaly](../gitaly/index.md#running-gitaly-on-its-own-server). + +You may also have a look at our troubleshooting guides for: -You may also have a look at our Troubleshooting Guides: +- [GitLab](../index.md#troubleshooting) +- [Omnibus GitLab](https://docs.gitlab.com/omnibus/README.html#troubleshooting) -- [Troubleshooting Guide (GitLab)](../index.md#troubleshooting) -- [Troubleshooting Guide (Omnibus GitLab)](https://docs.gitlab.com/omnibus/README.html#troubleshooting) +To run `gitlab:check`, run: **Omnibus Installation** @@ -77,7 +83,8 @@ sudo gitlab-rake gitlab:check bundle exec rake gitlab:check RAILS_ENV=production ``` -NOTE: Use `SANITIZE=true` for `gitlab:check` if you want to omit project names from the output. +NOTE: **Note:** +Use `SANITIZE=true` for `gitlab:check` if you want to omit project names from the output. Example output: @@ -126,7 +133,7 @@ Checking GitLab ... Finished ## Rebuild authorized_keys file -In some case it is necessary to rebuild the `authorized_keys` file. +In some case it is necessary to rebuild the `authorized_keys` file. To do this, run: **Omnibus Installation** @@ -141,6 +148,8 @@ cd /home/git/gitlab sudo -u git -H bundle exec rake gitlab:shell:setup RAILS_ENV=production ``` +Example output: + ```plaintext This will rebuild an authorized_keys file. You will lose any data stored in authorized_keys file. @@ -149,8 +158,8 @@ Do you want to continue (yes/no)? yes ## Clear Redis cache -If for some reason the dashboard shows wrong information you might want to -clear Redis' cache. +If for some reason the dashboard displays the wrong information, you might want to +clear Redis' cache. To do this, run: **Omnibus Installation** @@ -170,7 +179,7 @@ sudo -u git -H bundle exec rake cache:clear RAILS_ENV=production Sometimes during version upgrades you might end up with some wrong CSS or missing some icons. In that case, try to precompile the assets again. -Note that this only applies to source installations and does NOT apply to +This only applies to source installations and does NOT apply to Omnibus packages. **Source Installation** @@ -187,25 +196,6 @@ production machine after installing the package, there should be no reason to re `rake gitlab:assets:compile` on the production machine. If you suspect that assets have been corrupted, you should reinstall the omnibus package. -## Tracking Deployments - -GitLab provides a Rake task that lets you track deployments in GitLab -Performance Monitoring. This Rake task simply stores the current GitLab version -in the GitLab Performance Monitoring database. - -**Omnibus Installation** - -```shell -sudo gitlab-rake gitlab:track_deployment -``` - -**Source Installation** - -```shell -cd /home/git/gitlab -sudo -u git -H bundle exec rake gitlab:track_deployment RAILS_ENV=production -``` - ## Check TCP connectivity to a remote site Sometimes you need to know if your GitLab installation can connect to a TCP |