diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-29 00:09:38 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-29 00:09:38 +0000 |
commit | ac6a319712d345ab54d4eb5be1a0a4116823dd1e (patch) | |
tree | adb0a00d5876d35635e7ba87a9f63bfa16e2ba44 /doc/raketasks | |
parent | abe11a6a2c04112d0b7d6d4facfd0c8370f51831 (diff) | |
download | gitlab-ce-ac6a319712d345ab54d4eb5be1a0a4116823dd1e.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/raketasks')
-rw-r--r-- | doc/raketasks/README.md | 46 | ||||
-rw-r--r-- | doc/raketasks/backup_restore.md | 6 | ||||
-rw-r--r-- | doc/raketasks/cleanup.md | 8 | ||||
-rw-r--r-- | doc/raketasks/features.md | 2 | ||||
-rw-r--r-- | doc/raketasks/generate_sample_prometheus_data.md | 2 | ||||
-rw-r--r-- | doc/raketasks/import.md | 2 | ||||
-rw-r--r-- | doc/raketasks/list_repos.md | 2 | ||||
-rw-r--r-- | doc/raketasks/user_management.md | 2 | ||||
-rw-r--r-- | doc/raketasks/x509_signatures.md | 2 |
9 files changed, 37 insertions, 35 deletions
diff --git a/doc/raketasks/README.md b/doc/raketasks/README.md index c5723369470..3e048b399f9 100644 --- a/doc/raketasks/README.md +++ b/doc/raketasks/README.md @@ -15,26 +15,26 @@ GitLab Rake tasks are performed using: The following are available Rake tasks: -| Tasks | Description | -|:-------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------| -| [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. | -| [Development](../development/rake_tasks.md) | Tasks for GitLab contributors. | -| [Elasticsearch](../integration/elasticsearch.md#gitlab-elasticsearch-rake-tasks) | Maintain Elasticsearch in a GitLab instance. | -| [Enable namespaces](features.md) | Enable usernames and namespaces for user projects. | -| [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. | -| [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 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. | -| [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. | -| [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. | -| [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 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. | -| [Webhooks administration](web_hooks.md) | Maintain project Webhooks. | -| [X509 signatures](x509_signatures.md) | Update x509 commit signatures, useful if certificate store has changed. | +| Tasks | Description | +|:----------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------| +| [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. | +| [Development](../development/rake_tasks.md) | Tasks for GitLab contributors. | +| [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. | +| [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. | +| [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 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. | +| [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. | +| [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. | +| [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 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. | +| [Webhooks administration](web_hooks.md) | Maintain project Webhooks. | +| [X509 signatures](x509_signatures.md) | Update x509 commit signatures, useful if certificate store has changed. | diff --git a/doc/raketasks/backup_restore.md b/doc/raketasks/backup_restore.md index 78a0933ea15..0d5f7e6fa49 100644 --- a/doc/raketasks/backup_restore.md +++ b/doc/raketasks/backup_restore.md @@ -1,4 +1,4 @@ -# Backing up and restoring GitLab +# Backing up and restoring GitLab **(CORE ONLY)** GitLab provides Rake tasks for backing up and restoring GitLab instances. @@ -687,7 +687,7 @@ before restoring the backup. You need to have a working GitLab installation before you can perform a restore. This is mainly because the system user performing the 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 directory (repositories, uploads). @@ -713,7 +713,7 @@ more of the following options: 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. -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 will attempt to move these directories before restoring the new data and this would cause an error. diff --git a/doc/raketasks/cleanup.md b/doc/raketasks/cleanup.md index ef69b1cce15..e40fa1a9ef1 100644 --- a/doc/raketasks/cleanup.md +++ b/doc/raketasks/cleanup.md @@ -1,4 +1,4 @@ -# Clean up +# Clean up **(CORE ONLY)** 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. 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. For example: diff --git a/doc/raketasks/features.md b/doc/raketasks/features.md index 6ee958049a7..1d68671a545 100644 --- a/doc/raketasks/features.md +++ b/doc/raketasks/features.md @@ -1,4 +1,4 @@ -# Namespaces +# Namespaces **(CORE ONLY)** This Rake task enables [namespaces](../user/group/index.md#namespaces) for projects. diff --git a/doc/raketasks/generate_sample_prometheus_data.md b/doc/raketasks/generate_sample_prometheus_data.md index 7c321c3ac75..902be6862c8 100644 --- a/doc/raketasks/generate_sample_prometheus_data.md +++ b/doc/raketasks/generate_sample_prometheus_data.md @@ -1,4 +1,4 @@ -# 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 for a series of time intervals to now: diff --git a/doc/raketasks/import.md b/doc/raketasks/import.md index b6847dfbdb1..5229ce2ab08 100644 --- a/doc/raketasks/import.md +++ b/doc/raketasks/import.md @@ -1,4 +1,4 @@ -# Import bare repositories +# Import bare repositories **(CORE ONLY)** Rake tasks are available to import bare repositories into a GitLab instance. diff --git a/doc/raketasks/list_repos.md b/doc/raketasks/list_repos.md index 6437ff583ce..411de52e379 100644 --- a/doc/raketasks/list_repos.md +++ b/doc/raketasks/list_repos.md @@ -1,4 +1,4 @@ -# Listing repository directories +# Listing repository directories **(CORE ONLY)** You can print a list of all Git repositories on disk managed by GitLab. diff --git a/doc/raketasks/user_management.md b/doc/raketasks/user_management.md index 117240c20c4..61e30f9ddb1 100644 --- a/doc/raketasks/user_management.md +++ b/doc/raketasks/user_management.md @@ -1,4 +1,4 @@ -# User management +# User management **(CORE ONLY)** GitLab provides Rake tasks for user management. diff --git a/doc/raketasks/x509_signatures.md b/doc/raketasks/x509_signatures.md index 438e28361fa..ffc8f4f2a8f 100644 --- a/doc/raketasks/x509_signatures.md +++ b/doc/raketasks/x509_signatures.md @@ -1,4 +1,4 @@ -# X509 signatures +# X509 signatures **(CORE ONLY)** 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. |