From 580d2f928a55b4f01809737198c413efa77b8442 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Fri, 12 Feb 2021 14:04:07 +0000 Subject: [PATCH 1/3] Clarify separate Object Storage buckets in docs Updates the note on separate Object Storage buckets to call out that the same one can now be used generally unless using Helm. --- doc/administration/object_storage.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index ecc2c92425440a..97259c38c6e93d 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -571,22 +571,13 @@ See the following additional guides: ## Warnings, limitations, and known issues -### Use separate buckets +### Separate buckets required when using Helm -Using separate buckets for each data type is the recommended approach for GitLab. +Generally using the same bucket for your Object Storage is fine to do +for convenience. -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 that if your organisation decided to -migrate GitLab to the Helm deployment in the future. GitLab would run, but the situation with -backups might not be realised until the organisation had a critical requirement for the backups to work. +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). ### S3 API compatibility issues -- GitLab From c25028792fbeea69ecaa8d6bb386c87ca8be3727 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Fri, 12 Feb 2021 14:35:53 +0000 Subject: [PATCH 2/3] Remove unneeded link --- doc/administration/object_storage.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 97259c38c6e93d..9399687fc56328 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -75,8 +75,7 @@ types. If you want to use local storage for specific object types, you can Most types of objects, such as CI artifacts, LFS files, upload attachments, and so on can be saved in object storage by specifying a single -credential for object storage with multiple buckets. A [different bucket -for each type must be used](#use-separate-buckets). +credential for object storage with multiple buckets. When the consolidated form is: -- GitLab From 61fc391750acda889fbdf92dabfe62b41ce08c18 Mon Sep 17 00:00:00 2001 From: Grant Young Date: Fri, 12 Feb 2021 17:03:33 +0000 Subject: [PATCH 3/3] 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 9399687fc56328..3cad18dc497b92 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -572,10 +572,10 @@ See the following additional guides: ### Separate buckets required when using Helm -Generally using the same bucket for your Object Storage is fine to do +Generally, using the same bucket for your Object Storage is fine to do for convenience. -However if you're using or planning to use Helm, separate buckets will +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). ### S3 API compatibility issues -- GitLab