diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-24 15:10:16 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-24 15:10:16 +0300 |
commit | 5c8c561ac63d7b8f372316b4409500474220fcda (patch) | |
tree | 20586ba87f12052ee507171b07f61dd21d9f1fd8 /doc/administration | |
parent | b1b7c2f9a744197a111c81719c546a474adab4e8 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/administration')
-rw-r--r-- | doc/administration/raketasks/check.md | 10 | ||||
-rw-r--r-- | doc/administration/raketasks/geo.md | 4 | ||||
-rw-r--r-- | doc/administration/raketasks/github_import.md | 2 | ||||
-rw-r--r-- | doc/administration/raketasks/ldap.md | 6 | ||||
-rw-r--r-- | doc/administration/raketasks/maintenance.md | 39 | ||||
-rw-r--r-- | doc/administration/raketasks/project_import_export.md | 6 | ||||
-rw-r--r-- | doc/administration/raketasks/storage.md | 52 |
7 files changed, 46 insertions, 73 deletions
diff --git a/doc/administration/raketasks/check.md b/doc/administration/raketasks/check.md index fd869548fb4..f55c6e8e86b 100644 --- a/doc/administration/raketasks/check.md +++ b/doc/administration/raketasks/check.md @@ -1,8 +1,6 @@ -# Integrity check Rake task +# Integrity Check Rake Task -GitLab provides Rake tasks to check the integrity of various components. - -## Repository integrity +## Repository Integrity Even though Git is very resilient and tries to prevent data integrity issues, there are times when things go wrong. The following Rake tasks intend to @@ -45,7 +43,7 @@ sudo gitlab-rake gitlab:git:fsck sudo -u git -H bundle exec rake gitlab:git:fsck RAILS_ENV=production ``` -## Uploaded files integrity +## Uploaded Files Integrity Various types of files can be uploaded to a GitLab installation by users. These integrity checks can detect missing files. Additionally, for locally @@ -129,7 +127,7 @@ Checking integrity of Uploads Done! ``` -## LDAP check +## LDAP Check The LDAP check Rake task will test the bind DN and password credentials (if configured) and will list a sample of LDAP users. This task is also diff --git a/doc/administration/raketasks/geo.md b/doc/administration/raketasks/geo.md index 71e4f922348..707ed1dbee0 100644 --- a/doc/administration/raketasks/geo.md +++ b/doc/administration/raketasks/geo.md @@ -1,11 +1,9 @@ # Geo Rake Tasks **(PREMIUM ONLY)** -The following Rake tasks are for [Geo installations](../geo/replication/index.md). - ## Git housekeeping There are few tasks you can run to schedule a Git housekeeping to start at the -next repository sync in a **secondary** node: +next repository sync in a **Secondary node**: ### Incremental Repack diff --git a/doc/administration/raketasks/github_import.md b/doc/administration/raketasks/github_import.md index 2c2046de564..4c6521f38ec 100644 --- a/doc/administration/raketasks/github_import.md +++ b/doc/administration/raketasks/github_import.md @@ -9,7 +9,7 @@ which will become the owner of the project. You can resume an import with the same command. Bear in mind that the syntax is very specific. Remove any spaces within the argument block and -before/after the brackets. Also, some shells (for example, `zsh`) can interpret the open/close brackets +before/after the brackets. Also, Some shells (e.g., zsh) can interpret the open/close brackets (`[]`) separately. You may need to either escape the brackets or use double quotes. ## Importing multiple projects diff --git a/doc/administration/raketasks/ldap.md b/doc/administration/raketasks/ldap.md index ba08a41d92b..361ab28f6d4 100644 --- a/doc/administration/raketasks/ldap.md +++ b/doc/administration/raketasks/ldap.md @@ -1,6 +1,4 @@ -# LDAP Rake tasks - -The following are LDAP-related Rake tasks. +# LDAP Rake Tasks ## Check @@ -28,7 +26,7 @@ limit by passing a number to the check task: rake gitlab:ldap:check[50] ``` -## Run a group sync +## Run a Group Sync > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.2. diff --git a/doc/administration/raketasks/maintenance.md b/doc/administration/raketasks/maintenance.md index 56d5d239d15..c79a1aa6ba1 100644 --- a/doc/administration/raketasks/maintenance.md +++ b/doc/administration/raketasks/maintenance.md @@ -1,11 +1,8 @@ -# Maintenance Rake tasks +# Maintenance Rake Tasks -GitLab provides Rake tasks for general maintenance. +## Gather information about GitLab and the system it runs on -## 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. +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** @@ -53,23 +50,20 @@ Git: /usr/bin/git ## Check GitLab configuration -The `gitlab:check` Rake task runs the following Rake tasks: +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 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: +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). -- [GitLab](../index.md#troubleshooting) -- [Omnibus GitLab](https://docs.gitlab.com/omnibus/README.html#troubleshooting) +You may also have a look at our Troubleshooting Guides: -To run `gitlab:check`, run: +- [Troubleshooting Guide (GitLab)](../index.md#troubleshooting) +- [Troubleshooting Guide (Omnibus GitLab)](https://docs.gitlab.com/omnibus/README.html#troubleshooting) **Omnibus Installation** @@ -83,8 +77,7 @@ sudo gitlab-rake gitlab:check bundle exec rake gitlab:check RAILS_ENV=production ``` -NOTE: **Note:** -Use `SANITIZE=true` for `gitlab:check` if you want to omit project names from the output. +NOTE: Use `SANITIZE=true` for `gitlab:check` if you want to omit project names from the output. Example output: @@ -133,7 +126,7 @@ Checking GitLab ... Finished ## Rebuild authorized_keys file -In some case it is necessary to rebuild the `authorized_keys` file. To do this, run: +In some case it is necessary to rebuild the `authorized_keys` file. **Omnibus Installation** @@ -148,8 +141,6 @@ 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. @@ -158,8 +149,8 @@ Do you want to continue (yes/no)? yes ## Clear Redis cache -If for some reason the dashboard displays the wrong information, you might want to -clear Redis' cache. To do this, run: +If for some reason the dashboard shows wrong information you might want to +clear Redis' cache. **Omnibus Installation** @@ -179,7 +170,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. -This only applies to source installations and does NOT apply to +Note that this only applies to source installations and does NOT apply to Omnibus packages. **Source Installation** @@ -202,8 +193,6 @@ 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. -To run `gitlab:track_deployment`: - **Omnibus Installation** ```shell diff --git a/doc/administration/raketasks/project_import_export.md b/doc/administration/raketasks/project_import_export.md index 2ab8b13e29e..6d874d596e1 100644 --- a/doc/administration/raketasks/project_import_export.md +++ b/doc/administration/raketasks/project_import_export.md @@ -3,13 +3,11 @@ > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/3050) in GitLab 8.9. > - From GitLab 11.3, import/export can use object storage automatically. -GitLab provides Rake tasks relating to project import and export. For more information, see: +See also: - [Project import/export documentation](../../user/project/settings/import_export.md). - [Project import/export API](../../api/project_import_export.md). -## Import/export tasks - The GitLab import/export version can be checked by using the following command: ```shell @@ -30,6 +28,8 @@ sudo gitlab-rake gitlab:import_export:data bundle exec rake gitlab:import_export:data RAILS_ENV=production ``` +## Important notes + Note the following: - Importing is only possible if the version of the import and export GitLab instances are diff --git a/doc/administration/raketasks/storage.md b/doc/administration/raketasks/storage.md index 5d55b6cb9fe..e5ed9cd0dc1 100644 --- a/doc/administration/raketasks/storage.md +++ b/doc/administration/raketasks/storage.md @@ -1,4 +1,4 @@ -# Repository storage Rake tasks +# Repository Storage Rake Tasks This is a collection of Rake tasks you can use to help you list and migrate existing projects and attachments associated with it from Legacy storage to @@ -6,7 +6,7 @@ the new Hashed storage type. You can read more about the storage types [here](../repository_storage_types.md). -## Migrate existing projects to hashed storage +## Migrate existing projects to Hashed storage Before migrating your existing projects, you should [enable hashed storage](../repository_storage_types.md#how-to-migrate-to-hashed-storage) for the new projects as well. @@ -34,9 +34,9 @@ export ID_FROM=20 export ID_TO=50 ``` -You can monitor the progress in the **{admin}** **Admin Area > Monitoring > Background Jobs** page. -There is a specific queue you can watch to see how long it will take to finish: -`hashed_storage:hashed_storage_project_migrate`. +You can monitor the progress in the **Admin Area > Monitoring > Background Jobs** page. +There is a specific Queue you can watch to see how long it will take to finish: +`hashed_storage:hashed_storage_project_migrate` After it reaches zero, you can confirm every project has been migrated by running the commands bellow. If you find it necessary, you can run this migration script again to schedule missing projects. @@ -44,18 +44,16 @@ If you find it necessary, you can run this migration script again to schedule mi Any error or warning will be logged in Sidekiq's log file. NOTE: **Note:** -If [Geo](../geo/replication/index.md) is enabled, each project that is successfully migrated -generates an event to replicate the changes on any **secondary** nodes. +If Geo is enabled, each project that is successfully migrated generates an event to replicate the changes on any **secondary** nodes. You only need the `gitlab:storage:migrate_to_hashed` Rake task to migrate your repositories, but we have additional commands below that helps you inspect projects and attachments in both legacy and hashed storage. -## Rollback from hashed storage to legacy storage +## Rollback from Hashed storage to Legacy storage If you need to rollback the storage migration for any reason, you can follow the steps described here. -NOTE: **Note:** -Hashed storage will be required in future version of GitLab. +NOTE: **Note:** Hashed Storage will be required in future version of GitLab. To prevent new projects from being created in the Hashed storage, you need to undo the [enable hashed storage](../repository_storage_types.md#how-to-migrate-to-hashed-storage) changes. @@ -83,7 +81,7 @@ export ID_FROM=20 export ID_TO=50 ``` -You can monitor the progress in the **{admin}** **Admin Area > Monitoring > Background Jobs** page. +You can monitor the progress in the **Admin Area > Monitoring > Background Jobs** page. On the **Queues** tab, you can watch the `hashed_storage:hashed_storage_project_rollback` queue to see how long the process will take to finish. After it reaches zero, you can confirm every project has been rolled back by running the commands bellow. @@ -91,13 +89,9 @@ If some projects weren't rolled back, you can run this rollback script again to Any error or warning will be logged in Sidekiq's log file. -## List projects - -The following are Rake tasks for listing projects. - -### List projects on legacy storage +## List projects on Legacy storage -To have a simple summary of projects using legacy storage: +To have a simple summary of projects using **Legacy** storage: **Omnibus Installation** @@ -111,7 +105,7 @@ sudo gitlab-rake gitlab:storage:legacy_projects sudo -u git -H bundle exec rake gitlab:storage:legacy_projects RAILS_ENV=production ``` -To list projects using legacy storage: +To list projects using **Legacy** storage: **Omnibus Installation** @@ -126,9 +120,9 @@ sudo -u git -H bundle exec rake gitlab:storage:list_legacy_projects RAILS_ENV=pr ``` -### List projects on hashed storage +## List projects on Hashed storage -To have a simple summary of projects using hashed storage: +To have a simple summary of projects using **Hashed** storage: **Omnibus Installation** @@ -142,7 +136,7 @@ sudo gitlab-rake gitlab:storage:hashed_projects sudo -u git -H bundle exec rake gitlab:storage:hashed_projects RAILS_ENV=production ``` -To list projects using hashed storage: +To list projects using **Hashed** storage: **Omnibus Installation** @@ -156,13 +150,9 @@ sudo gitlab-rake gitlab:storage:list_hashed_projects sudo -u git -H bundle exec rake gitlab:storage:list_hashed_projects RAILS_ENV=production ``` -## List attachments - -The following are Rake tasks for listing attachments. - -### List attachments on legacy storage +## List attachments on Legacy storage -To have a simple summary of project attachments using legacy storage: +To have a simple summary of project attachments using **Legacy** storage: **Omnibus Installation** @@ -176,7 +166,7 @@ sudo gitlab-rake gitlab:storage:legacy_attachments sudo -u git -H bundle exec rake gitlab:storage:legacy_attachments RAILS_ENV=production ``` -To list project attachments using legacy storage: +To list project attachments using **Legacy** storage: **Omnibus Installation** @@ -190,9 +180,9 @@ sudo gitlab-rake gitlab:storage:list_legacy_attachments sudo -u git -H bundle exec rake gitlab:storage:list_legacy_attachments RAILS_ENV=production ``` -### List attachments on hashed storage +## List attachments on Hashed storage -To have a simple summary of project attachments using hashed storage: +To have a simple summary of project attachments using **Hashed** storage: **Omnibus Installation** @@ -206,7 +196,7 @@ sudo gitlab-rake gitlab:storage:hashed_attachments sudo -u git -H bundle exec rake gitlab:storage:hashed_attachments RAILS_ENV=production ``` -To list project attachments using hashed storage: +To list project attachments using **Hashed** storage: **Omnibus Installation** |