Skip to content

G
gitlab-ce
Commit d258c3c4 authored by Evan Read's avatar Evan Read
Browse files
Options

Add tier badges to Rake task topics 

Fixes any links to renamed sections
parent 63c5d2f7
Hide whitespace changes
Inline Side-by-side
Showing with 50 additions and 46 deletions
doc/.vale/gitlab/spelling-exceptions.txt
View file @ d258c3c4
...@@ -237,6 +237,7 @@ Qualys ...@@ -237,6 +237,7 @@ Qualys
Rackspace Rackspace
Raketask Raketask
Raketasks Raketasks
reachability
rebase rebase
rebased rebased
rebases rebases
...@@ -372,6 +373,7 @@ unstage ...@@ -372,6 +373,7 @@ unstage
unstaged unstaged
unstages unstages
unstaging unstaging
untarred
untracked untracked
untrusted untrusted
unverified unverified
......
doc/administration/auth/ldap-troubleshooting.md
View file @ d258c3c4
...@@ -312,7 +312,7 @@ things to check to debug the situation. ...@@ -312,7 +312,7 @@ things to check to debug the situation.
interval](ldap-ee.md#adjusting-ldap-group-sync-schedule) for the group to interval](ldap-ee.md#adjusting-ldap-group-sync-schedule) for the group to
sync. To speed up the process, either go to the GitLab group **Settings -> sync. To speed up the process, either go to the GitLab group **Settings ->
Members** and press **Sync now** (sync one group) or [run the group sync Rake Members** and press **Sync now** (sync one group) or [run the group sync Rake
task](../raketasks/ldap.md#run-a-group-sync) (sync all groups). task](../raketasks/ldap.md#run-a-group-sync-starter-only) (sync all groups).
If all of the above looks good, jump in to a little more advanced debugging in If all of the above looks good, jump in to a little more advanced debugging in
the rails console. the rails console.
...@@ -352,7 +352,7 @@ GitLab syncs the `admin_group`. ...@@ -352,7 +352,7 @@ GitLab syncs the `admin_group`.
NOTE: **NOTE:** NOTE: **NOTE:**
To sync all groups manually when debugging is unnecessary, [use the Rake To sync all groups manually when debugging is unnecessary, [use the Rake
task](../raketasks/ldap.md#run-a-group-sync) instead. task](../raketasks/ldap.md#run-a-group-sync-starter-only) instead.
The output from a manual [group sync](ldap-ee.md#group-sync) can show you what happens The output from a manual [group sync](ldap-ee.md#group-sync) can show you what happens
when GitLab syncs its LDAP group memberships against LDAP. when GitLab syncs its LDAP group memberships against LDAP.
......
doc/administration/raketasks/check.md
View file @ d258c3c4
# Integrity check Rake task # Integrity check Rake task **(CORE ONLY)**
GitLab provides Rake tasks to check the integrity of various components. GitLab provides Rake tasks to check the integrity of various components.
......
doc/administration/raketasks/github_import.md
View file @ d258c3c4
# GitHub import # GitHub import **(CORE ONLY)**
> [Introduced]( https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10308) in GitLab 9.1. > [Introduced]( https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10308) in GitLab 9.1.
......
doc/administration/raketasks/ldap.md
View file @ d258c3c4
# LDAP Rake tasks # LDAP Rake tasks **(CORE ONLY)**
The following are LDAP-related Rake tasks. The following are LDAP-related Rake tasks.
...@@ -28,7 +28,7 @@ limit by passing a number to the check task: ...@@ -28,7 +28,7 @@ limit by passing a number to the check task:
rake gitlab:ldap:check[50] rake gitlab:ldap:check[50]
``` ```
## Run a group sync ## Run a group sync **(STARTER ONLY)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.2. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/14735) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.2.
......
doc/administration/raketasks/maintenance.md
View file @ d258c3c4
# Maintenance Rake tasks # Maintenance Rake tasks **(CORE ONLY)**
GitLab provides Rake tasks for general maintenance. GitLab provides Rake tasks for general maintenance.
......
doc/administration/raketasks/praefect.md
View file @ d258c3c4
# Praefect Rake Tasks # Praefect Rake Tasks **(CORE ONLY)**
> [Introduced]( https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28369) in GitLab 12.10. > [Introduced]( https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28369) in GitLab 12.10.
......
doc/administration/raketasks/storage.md
View file @ d258c3c4
# Repository storage Rake tasks # Repository storage Rake tasks **(CORE ONLY)**
This is a collection of Rake tasks you can use to help you list and migrate 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 existing projects and attachments associated with it from Legacy storage to
......
doc/administration/raketasks/uploads/migrate.md
View file @ d258c3c4
# Uploads migrate Rake tasks # Uploads migrate Rake tasks **(CORE ONLY)**
`gitlab:uploads:migrate` migrates uploads between different storage types. `gitlab:uploads:migrate` migrates uploads between different storage types.
......
doc/administration/raketasks/uploads/sanitize.md
View file @ d258c3c4
# Uploads sanitize Rake tasks # Uploads sanitize Rake tasks **(CORE ONLY)**
Since GitLab 11.9, EXIF data is automatically stripped from JPG or TIFF image uploads. Since GitLab 11.9, EXIF data is automatically stripped from JPG or TIFF image uploads.
......
doc/raketasks/README.md
View file @ d258c3c4
...@@ -15,26 +15,26 @@ GitLab Rake tasks are performed using: ...@@ -15,26 +15,26 @@ GitLab Rake tasks are performed using:
The following are available Rake tasks: The following are available Rake tasks:
| Tasks | Description | | Tasks | Description |
|:-------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------| |:----------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------|
| [Back up and restore](backup_restore.md) | Back up, restore, and migrate GitLab instances between servers. | | [Back up and restore](backup_restore.md) | Back up, restore, and migrate GitLab instances between servers. |
| [Clean up](cleanup.md) | Clean up unneeded items from GitLab instances. | | [Clean up](cleanup.md) | Clean up unneeded items from GitLab instances. |
| [Development](../development/rake_tasks.md) | Tasks for GitLab contributors. | | [Development](../development/rake_tasks.md) | Tasks for GitLab contributors. |
| [Elasticsearch](../integration/elasticsearch.md#gitlab-elasticsearch-rake-tasks) | Maintain Elasticsearch in a GitLab instance. | | [Elasticsearch](../integration/elasticsearch.md#gitlab-elasticsearch-rake-tasks) **(STARTER ONLY)** | Maintain Elasticsearch in a GitLab instance. |
| [Enable namespaces](features.md) | Enable usernames and namespaces for user projects. | | [Enable namespaces](features.md) | Enable usernames and namespaces for user projects. |
| [General maintenance](../administration/raketasks/maintenance.md) | General maintenance and self-check tasks. | | [General maintenance](../administration/raketasks/maintenance.md) | General maintenance and self-check tasks. |
| [Geo maintenance](../administration/raketasks/geo.md) **(PREMIUM ONLY)** | [Geo](../administration/geo/replication/index.md)-related maintenance. | | [Geo maintenance](../administration/raketasks/geo.md) **(PREMIUM ONLY)** | [Geo](../administration/geo/replication/index.md)-related maintenance. |
| [GitHub import](../administration/raketasks/github_import.md) | Retrieve and import repositories from GitHub. | | [GitHub import](../administration/raketasks/github_import.md) | Retrieve and import repositories from GitHub. |
| [Import repositories](import.md) | Import bare repositories into your GitLab instance. | | [Import repositories](import.md) | Import bare repositories into your GitLab instance. |
| [Import large project exports](../development/import_project.md#importing-via-a-rake-task) | Import large GitLab [project exports](../user/project/settings/import_export.md). | | [Import large project exports](../development/import_project.md#importing-via-a-rake-task) | Import large GitLab [project exports](../user/project/settings/import_export.md). |
| [Integrity checks](../administration/raketasks/check.md) | Check the integrity of repositories, files, and LDAP. | | [Integrity checks](../administration/raketasks/check.md) | Check the integrity of repositories, files, and LDAP. |
| [LDAP maintenance](../administration/raketasks/ldap.md) | [LDAP](../administration/auth/ldap.md)-related tasks. | | [LDAP maintenance](../administration/raketasks/ldap.md) | [LDAP](../administration/auth/ldap.md)-related tasks. |
| [List repositories](list_repos.md) | List of all GitLab-managed Git repositories on disk. | | [List repositories](list_repos.md) | List of all GitLab-managed Git repositories on disk. |
| [Project import/export](../administration/raketasks/project_import_export.md) | Prepare for [project exports and imports](../user/project/settings/import_export.md). | | [Project import/export](../administration/raketasks/project_import_export.md) | Prepare for [project exports and imports](../user/project/settings/import_export.md). |
| [Sample Prometheus data](generate_sample_prometheus_data.md) | Generate sample Prometheus data. | | [Sample Prometheus data](generate_sample_prometheus_data.md) | Generate sample Prometheus data. |
| [Repository storage](../administration/raketasks/storage.md) | List and migrate existing projects and attachments from legacy storage to hashed storage. | | [Repository storage](../administration/raketasks/storage.md) | List and migrate existing projects and attachments from legacy storage to hashed storage. |
| [Uploads migrate](../administration/raketasks/uploads/migrate.md) | Migrate uploads between storage local and object storage. | | [Uploads migrate](../administration/raketasks/uploads/migrate.md) | Migrate uploads between storage local and object storage. |
| [Uploads sanitize](../administration/raketasks/uploads/sanitize.md) | Remove EXIF data from images uploaded to earlier versions of GitLab. | | [Uploads sanitize](../administration/raketasks/uploads/sanitize.md) | Remove EXIF data from images uploaded to earlier versions of GitLab. |
| [User management](user_management.md) | Perform user management tasks. | | [User management](user_management.md) | Perform user management tasks. |
| [Webhooks administration](web_hooks.md) | Maintain project Webhooks. | | [Webhooks administration](web_hooks.md) | Maintain project Webhooks. |
| [X509 signatures](x509_signatures.md) | Update x509 commit signatures, useful if certificate store has changed. | | [X509 signatures](x509_signatures.md) | Update x509 commit signatures, useful if certificate store has changed. |
doc/raketasks/backup_restore.md
View file @ d258c3c4
# Backing up and restoring GitLab # Backing up and restoring GitLab **(CORE ONLY)**
GitLab provides Rake tasks for backing up and restoring GitLab instances. GitLab provides Rake tasks for backing up and restoring GitLab instances.
...@@ -687,7 +687,7 @@ before restoring the backup. ...@@ -687,7 +687,7 @@ before restoring the backup.
You need to have a working GitLab installation before you can perform You need to have a working GitLab installation before you can perform
a restore. This is mainly because the system user performing the a restore. This is mainly because the system user performing the
restore actions (`git`) is usually not allowed to create or delete restore actions (`git`) is usually not allowed to create or delete
the SQL database it needs to import data into ('gitlabhq_production'). the SQL database it needs to import data into (`gitlabhq_production`).
All existing data will be either erased (SQL) or moved to a separate All existing data will be either erased (SQL) or moved to a separate
directory (repositories, uploads). directory (repositories, uploads).
...@@ -713,7 +713,7 @@ more of the following options: ...@@ -713,7 +713,7 @@ more of the following options:
Read what the [backup timestamp is about](#backup-timestamp). Read what the [backup timestamp is about](#backup-timestamp).
- `force=yes` - Does not ask if the authorized_keys file should get regenerated and assumes 'yes' for warning that database tables will be removed, enabling the "Write to authorized_keys file" setting, and updating LDAP providers. - `force=yes` - Does not ask if the authorized_keys file should get regenerated and assumes 'yes' for warning that database tables will be removed, enabling the "Write to authorized_keys file" setting, and updating LDAP providers.
If you are restoring into directories that are mountpoints you will need to make If you are restoring into directories that are mount points, you will need to make
sure these directories are empty before attempting a restore. Otherwise GitLab sure these directories are empty before attempting a restore. Otherwise GitLab
will attempt to move these directories before restoring the new data and this will attempt to move these directories before restoring the new data and this
would cause an error. would cause an error.
......
doc/raketasks/cleanup.md
View file @ d258c3c4
# Clean up # Clean up **(CORE ONLY)**
GitLab provides Rake tasks for cleaning up GitLab instances. GitLab provides Rake tasks for cleaning up GitLab instances.
...@@ -7,9 +7,11 @@ GitLab provides Rake tasks for cleaning up GitLab instances. ...@@ -7,9 +7,11 @@ GitLab provides Rake tasks for cleaning up GitLab instances.
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/36628) in GitLab 12.10. > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/36628) in GitLab 12.10.
DANGER: **Danger:** DANGER: **Danger:**
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. 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 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. will allow garbage collection of LFS files.
For example: For example:
......
doc/raketasks/features.md
View file @ d258c3c4
# Namespaces # Namespaces **(CORE ONLY)**
This Rake task enables [namespaces](../user/group/index.md#namespaces) for projects. This Rake task enables [namespaces](../user/group/index.md#namespaces) for projects.
......
doc/raketasks/generate_sample_prometheus_data.md
View file @ d258c3c4
# Generate sample Prometheus data # Generate sample Prometheus data **(CORE ONLY)**
This command will run Prometheus queries for each of the metrics of a specific environment This command will run Prometheus queries for each of the metrics of a specific environment
for a series of time intervals to now: for a series of time intervals to now:
......
doc/raketasks/import.md
View file @ d258c3c4
# Import bare repositories # Import bare repositories **(CORE ONLY)**
Rake tasks are available to import bare repositories into a GitLab instance. Rake tasks are available to import bare repositories into a GitLab instance.
......
doc/raketasks/list_repos.md
View file @ d258c3c4
# Listing repository directories # Listing repository directories **(CORE ONLY)**
You can print a list of all Git repositories on disk managed by GitLab. You can print a list of all Git repositories on disk managed by GitLab.
......
doc/raketasks/user_management.md
View file @ d258c3c4
# User management # User management **(CORE ONLY)**
GitLab provides Rake tasks for user management. GitLab provides Rake tasks for user management.
......
doc/raketasks/x509_signatures.md
View file @ d258c3c4
# X509 signatures # X509 signatures **(CORE ONLY)**
When [signing commits with x509](../user/project/repository/x509_signed_commits/index.md), When [signing commits with x509](../user/project/repository/x509_signed_commits/index.md),
the trust anchor might change and the signatures stored within the database must be updated. the trust anchor might change and the signatures stored within the database must be updated.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7