From a09a06c655f19ea26a581119b7c3755212a6634c Mon Sep 17 00:00:00 2001 From: Grant Young Date: Mon, 15 Feb 2021 16:20:00 +0000 Subject: [PATCH 1/5] Adjust Object Storage guidance further We do want to recommend separate buckets. --- doc/administration/object_storage.md | 11 ++--- .../reference_architectures/10k_users.md | 44 +++++++----------- .../reference_architectures/25k_users.md | 44 +++++++----------- .../reference_architectures/2k_users.md | 28 ++++-------- .../reference_architectures/3k_users.md | 45 +++++++------------ .../reference_architectures/50k_users.md | 44 +++++++----------- .../reference_architectures/5k_users.md | 44 +++++++----------- 7 files changed, 96 insertions(+), 164 deletions(-) diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 3cad18dc497b92..9a5830b56be1cb 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -570,13 +570,14 @@ See the following additional guides: ## Warnings, limitations, and known issues -### Separate buckets required when using Helm +### Use separate buckets -Generally, using the same bucket for your Object Storage is fine to do -for convenience. +Using separate buckets for each data type is the recommended approach for GitLab. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores. -However, if you're using or planning to use Helm, separate buckets will -be required as there is a [known limitation with restorations of Helm chart backups](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer). +For Helm based installs this is additionally required to +[handle backup restorations](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) ### S3 API compatibility issues diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index d4d522ab1b84a5..7e96c096edca60 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -1940,13 +1940,13 @@ To configure the Sidekiq nodes, on each one: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from your Consul server, and replace @@ -2069,13 +2069,13 @@ On each node perform the following: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). @@ -2303,20 +2303,8 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. - -A limitation of our configuration is that each use of object storage is separately configured. -[We have an issue for improving this](https://gitlab.com/gitlab-org/gitlab/-/issues/23345) -and easily using one bucket with separate folders is one improvement that this might bring. - -There is at least one specific issue with using the same bucket: -when GitLab is deployed with the Helm chart restore from backup -[will not properly function](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) -unless separate buckets are used. - -One risk of using a single bucket would be if your organization decided to -migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with -backups might not be realized until the organization had a critical requirement for the backups to -work. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores.
diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 48c72bb930d2b8..4452e33954bf5a 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -1637,13 +1637,13 @@ To configure the Sidekiq nodes, on each one: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from your Consul server, and replace @@ -1769,13 +1769,13 @@ On each node perform the following: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). @@ -2002,20 +2002,8 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. - -A limitation of our configuration is that each use of object storage is separately configured. -[We have an issue for improving this](https://gitlab.com/gitlab-org/gitlab/-/issues/23345) -and easily using one bucket with separate folders is one improvement that this might bring. - -There is at least one specific issue with using the same bucket: -when GitLab is deployed with the Helm chart restore from backup -[will not properly function](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) -unless separate buckets are used. - -One risk of using a single bucket would be if your organization decided to -migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with -backups might not be realized until the organization had a critical requirement for the backups to -work. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores.
diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 9ad6054104a26c..3001160bddd549 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -668,13 +668,13 @@ On each node perform the following: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ## Uncomment and edit the following options if you have set up NFS ## @@ -920,18 +920,8 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. - -A limitation of our configuration is that each use of object storage is -separately configured. We have an [issue](https://gitlab.com/gitlab-org/gitlab/-/issues/23345) -for improving this, which would allow for one bucket with separate folders. - -Using a single bucket when GitLab is deployed with the Helm chart causes -restoring from a backup to -[not function properly](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer). -Although you may not be using a Helm deployment right now, if you migrate -GitLab to a Helm deployment later, GitLab would still work, but you may not -realize backups aren't working correctly until a critical requirement for -functioning backups is encountered. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores.
diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 175c4318d78daf..8f9c29dcea652e 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -1322,13 +1322,14 @@ To configure the Sidekiq nodes, one each one: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + ``` 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). @@ -1489,13 +1490,13 @@ On each node perform the following: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. If you're using [Gitaly with TLS support](#gitaly-tls-support), make sure the @@ -1697,20 +1698,8 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. - -A limitation of our configuration is that each use of object storage is separately configured. -[We have an issue for improving this](https://gitlab.com/gitlab-org/gitlab/-/issues/23345) -and easily using one bucket with separate folders is one improvement that this might bring. - -There is at least one specific issue with using the same bucket: -when GitLab is deployed with the Helm chart restore from backup -[will not properly function](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) -unless separate buckets are used. - -One risk of using a single bucket would be if your organization decided to -migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with -backups might not be realized until the organization had a critical requirement for the backups to -work. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores.
diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 0b22a2d3602bb0..8f1948084c4707 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -1637,13 +1637,13 @@ To configure the Sidekiq nodes, on each one: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Copy the `/etc/gitlab/gitlab-secrets.json` file from your Consul server, and replace @@ -1769,13 +1769,13 @@ On each node perform the following: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). @@ -2002,20 +2002,8 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. - -A limitation of our configuration is that each use of object storage is separately configured. -[We have an issue for improving this](https://gitlab.com/gitlab-org/gitlab/-/issues/23345) -and easily using one bucket with separate folders is one improvement that this might bring. - -There is at least one specific issue with using the same bucket: -when GitLab is deployed with the Helm chart restore from backup -[will not properly function](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) -unless separate buckets are used. - -One risk of using a single bucket would be if your organization decided to -migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with -backups might not be realized until the organization had a critical requirement for the backups to -work. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores.
diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 37d35c299fa425..3b06694692b132 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -1319,13 +1319,13 @@ To configure the Sidekiq nodes, one each one: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ``` 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). @@ -1471,13 +1471,13 @@ On each node perform the following: 'google_project' => '', 'google_json_key_location' => '' } - gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" - gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" - gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" - gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" - gitlab_rails['object_store']['objects']['packages']['bucket'] = "" - gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" - gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" + gitlab_rails['object_store']['objects']['artifacts']['bucket'] = "" + gitlab_rails['object_store']['objects']['external_diffs']['bucket'] = "" + gitlab_rails['object_store']['objects']['lfs']['bucket'] = "" + gitlab_rails['object_store']['objects']['uploads']['bucket'] = "" + gitlab_rails['object_store']['objects']['packages']['bucket'] = "" + gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = "" + gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = "" ## Uncomment and edit the following options if you have set up NFS ## @@ -1694,20 +1694,8 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. - -A limitation of our configuration is that each use of object storage is separately configured. -[We have an issue for improving this](https://gitlab.com/gitlab-org/gitlab/-/issues/23345) -and easily using one bucket with separate folders is one improvement that this might bring. - -There is at least one specific issue with using the same bucket: -when GitLab is deployed with the Helm chart restore from backup -[will not properly function](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) -unless separate buckets are used. - -One risk of using a single bucket would be if your organization decided to -migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with -backups might not be realized until the organization had a critical requirement for the backups to -work. +This is recommended to ensure there's no collisions across the various types of +data GitLab stores.
-- GitLab From 60393d9df11360bce0b480703715c31b40c3db2a Mon Sep 17 00:00:00 2001 From: Grant Young Date: Tue, 16 Feb 2021 10:04:29 +0000 Subject: [PATCH 2/5] Apply 2 suggestion(s) to 1 file(s) --- doc/administration/object_storage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 9a5830b56be1cb..e37736c632b55a 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -573,10 +573,10 @@ See the following additional guides: ### Use separate buckets Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of +This ensures there's no collisions across the various types of data GitLab stores. -For Helm based installs this is additionally required to +Helm-based installs require separate buckets to [handle backup restorations](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) ### S3 API compatibility issues -- GitLab From b738c4979c012e01cc1f2f7da5a9fef752f05948 Mon Sep 17 00:00:00 2001 From: Stan Hu Date: Tue, 16 Feb 2021 19:15:12 +0000 Subject: [PATCH 3/5] Apply 2 suggestion(s) to 2 file(s) --- doc/administration/object_storage.md | 2 +- doc/administration/reference_architectures/10k_users.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index e37736c632b55a..72847d11395dbe 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -573,7 +573,7 @@ See the following additional guides: ### Use separate buckets Using separate buckets for each data type is the recommended approach for GitLab. -This ensures there's no collisions across the various types of +This ensures there are no collisions across the various types of data GitLab stores. Helm-based installs require separate buckets to diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 7e96c096edca60..6d3d9129913d34 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2303,7 +2303,7 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of +This is recommended to ensure there are no collisions across the various types of data GitLab stores.
-- GitLab From 5d0fdb7c17112c1049d9454109b218c62c6ec768 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Wed, 17 Feb 2021 13:05:27 +0000 Subject: [PATCH 4/5] Apply 1 suggestion(s) to 1 file(s) --- doc/administration/object_storage.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 72847d11395dbe..a14f902db91f67 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -573,8 +573,9 @@ See the following additional guides: ### Use separate buckets Using separate buckets for each data type is the recommended approach for GitLab. -This ensures there are no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future. Helm-based installs require separate buckets to [handle backup restorations](https://docs.gitlab.com/charts/advanced/external-object-storage/#lfs-artifacts-uploads-packages-external-diffs-pseudonymizer) -- GitLab From 8d425817cb1f1175cde4fbebec47ed2b8f453813 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Wed, 17 Feb 2021 13:08:58 +0000 Subject: [PATCH 5/5] Update RA with link to object storage issue --- doc/administration/reference_architectures/10k_users.md | 5 +++-- doc/administration/reference_architectures/25k_users.md | 5 +++-- doc/administration/reference_architectures/2k_users.md | 5 +++-- doc/administration/reference_architectures/3k_users.md | 5 +++-- doc/administration/reference_architectures/50k_users.md | 5 +++-- doc/administration/reference_architectures/5k_users.md | 5 +++-- 6 files changed, 18 insertions(+), 12 deletions(-) diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 6d3d9129913d34..e337e449cdd0ed 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2303,8 +2303,9 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there are no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future.
diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 4452e33954bf5a..d02f7ea66ac61c 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2002,8 +2002,9 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future.
diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 3001160bddd549..62f0c993213ef4 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -920,8 +920,9 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future.
diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 8f9c29dcea652e..593bfaf7282e3e 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -1698,8 +1698,9 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future.
diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 8f1948084c4707..04ce39046d8f8b 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2002,8 +2002,9 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future.
diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 3b06694692b132..37e67b0ab733b7 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -1694,8 +1694,9 @@ on what features you intend to use: | [Terraform state files](../terraform_state.md#using-object-storage) | Yes | Using separate buckets for each data type is the recommended approach for GitLab. -This is recommended to ensure there's no collisions across the various types of -data GitLab stores. +This ensures there are no collisions across the various types of data GitLab stores. +There are plans to [enable the use of a single bucket](https://gitlab.com/gitlab-org/gitlab/-/issues/292958) +in the future.