From 64abb61425311e3e805675a2946d5e07693f4c28 Mon Sep 17 00:00:00 2001 From: Sami Hiltunen Date: Thu, 11 Aug 2022 13:57:25 +0300 Subject: [PATCH 1/2] Document the default enabling of Praefect generated replica paths This commit documents the default enabling of the feature flag guarding Praefect generated replica paths. As the introduced section rules have changed since they were last modified, this commit rewrites the section to align with the current rules. --- doc/administration/gitaly/index.md | 7 ++++--- doc/administration/gitaly/praefect.md | 3 +-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index be95c5e5c810b5..493ebd5ba14de7 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -297,11 +297,12 @@ follow the [hashed storage](../repository_storage_types.md#hashed-storage) schem #### Praefect-generated replica paths (GitLab 15.0 and later) -> Introduced in GitLab 15.0 behind [a feature flag](https://gitlab.com/gitlab-org/gitaly/-/issues/4218) named `gitaly_praefect_generated_replica_paths`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/4218) in GitLab 15.0 [with a flag](../feature_flags.md) named `gitaly_praefect_generated_replica_paths`. Disabled by default. +> - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitaly/-/issues/4218) in GitLab 15.2. +> - [Enabled on self-managed](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4809) in GitLab 15.3. FLAG: -On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to [enable the feature flag](../feature_flags.md) -named `gitaly_praefect_generated_replica_paths`. On GitLab.com, this feature is available but can be configured by GitLab.com administrators only. The feature is not ready for production use. +On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag](../feature_flags.md) named `gitaly_praefect_generated_replica_paths`. On GitLab.com, this feature is available but can be configured by GitLab.com administrators only. When Gitaly Cluster creates a repository, it assigns the repository a unique and permanent ID called the _repository ID_. The repository ID is internal to Gitaly Cluster and doesn't relate to any IDs elsewhere in GitLab. If a repository is removed from Gitaly Cluster and later moved diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 3c007ce8ff32ee..20c3643f32dc83 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -1317,8 +1317,7 @@ praefect['background_verification_verification_interval'] = '0' WARNING: Deletions are disabled by default due to a race condition with repository renames that can cause incorrect deletions. This is especially prominent in Geo instances as Geo performs more renames than instances without Geo. -See [Handle repository creations, deletions and renames atomically](https://gitlab.com/gitlab-org/gitaly/-/merge_requests/4101) -for progress on a fix. We do not recommend enabling the deletions until this is fixed. +This functionality should not be enabled if the [`gitaly_praefect_generated_replica_paths` feature flag](index.md#praefect-generated-replica-paths-gitlab-150-and-later) is disabled. By default, the worker does not delete invalid metadata records but simply logs them and outputs Prometheus metrics for them. -- GitLab From 981f9f5d3bfb7af0df6657dc7fb951a5202178ce Mon Sep 17 00:00:00 2001 From: Evan Read Date: Fri, 12 Aug 2022 06:06:42 +0000 Subject: [PATCH 2/2] Apply 1 suggestion(s) to 1 file(s) --- doc/administration/gitaly/praefect.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/administration/gitaly/praefect.md b/doc/administration/gitaly/praefect.md index 20c3643f32dc83..488e6a0df5fc0c 100644 --- a/doc/administration/gitaly/praefect.md +++ b/doc/administration/gitaly/praefect.md @@ -1317,7 +1317,7 @@ praefect['background_verification_verification_interval'] = '0' WARNING: Deletions are disabled by default due to a race condition with repository renames that can cause incorrect deletions. This is especially prominent in Geo instances as Geo performs more renames than instances without Geo. -This functionality should not be enabled if the [`gitaly_praefect_generated_replica_paths` feature flag](index.md#praefect-generated-replica-paths-gitlab-150-and-later) is disabled. +You should enable deletions only if the [`gitaly_praefect_generated_replica_paths` feature flag](index.md#praefect-generated-replica-paths-gitlab-150-and-later) is enabled. By default, the worker does not delete invalid metadata records but simply logs them and outputs Prometheus metrics for them. -- GitLab