diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index ad8a8217536c5b039ed0840012a7948e84b4f0dc..05762ce89aec44ca722429e6b6cea031eb00c54d 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -119,6 +119,7 @@ The following table lists the valid `objects` that can be used: | `dependency_proxy` | [Dependency Proxy](packages/dependency_proxy.md) | | `terraform_state` | [Terraform state files](terraform_state.md) | | `pages` | [Pages](pages/index.md) | +| `ci_secure_files` | [Secure files](secure_files.md) | Within each object type, three parameters can be defined: @@ -166,11 +167,11 @@ supported by the consolidated form, refer to the following guides: | Object storage type | Supported by consolidated form? | |---------------------|------------------------------------------| -| [Secure Files](secure_files.md#using-object-storage) | **{dotted-circle}** No | | [Backups](../administration/backup_restore/backup_gitlab.md#upload-backups-to-a-remote-cloud-storage) | **{dotted-circle}** No | | [Container registry](packages/container_registry.md#use-object-storage) (optional feature) | **{dotted-circle}** No | | [Mattermost](https://docs.mattermost.com/configure/file-storage-configuration-settings.html)| **{dotted-circle}** No | | [Autoscale runner caching](https://docs.gitlab.com/runner/configuration/autoscale.html#distributed-runners-caching) (optional for improved performance) | **{dotted-circle}** No | +| [Secure Files](secure_files.md#using-object-storage) | **{check-circle}** Yes | | [Job artifacts](job_artifacts.md#using-object-storage) including archived job logs | **{check-circle}** Yes | | [LFS objects](lfs/index.md#storing-lfs-objects-in-remote-object-storage) | **{check-circle}** Yes | | [Uploads](uploads.md#using-object-storage) | **{check-circle}** Yes | @@ -483,6 +484,7 @@ The following example uses AWS S3 to enable object storage for all supported ser gitlab_rails['object_store']['objects']['packages']['bucket'] = 'gitlab-packages' gitlab_rails['object_store']['objects']['dependency_proxy']['bucket'] = 'gitlab-dependency-proxy' gitlab_rails['object_store']['objects']['terraform_state']['bucket'] = 'gitlab-terraform-state' + gitlab_rails['object_store']['objects']['ci_secure_files']['bucket'] = 'gitlab-ci-secure-files' gitlab_rails['object_store']['objects']['pages']['bucket'] = 'gitlab-pages' ``` diff --git a/doc/administration/secure_files.md b/doc/administration/secure_files.md index e5d52917d09c9770f2f056a91c88614104b12624..51febd8300fff1f798fd8a466a931803b529ed3d 100644 --- a/doc/administration/secure_files.md +++ b/doc/administration/secure_files.md @@ -97,13 +97,14 @@ DETAILS: Instead of storing Secure Files on disk, you should use [one of the supported object storage options](object_storage.md#supported-object-storage-providers). This configuration relies on valid credentials to be configured already. -[Read more about using object storage with GitLab](object_storage.md). +### Consolidated object storage -NOTE: -This feature is not supported by consolidated object storage configuration. -Adding support is proposed in [issue 414673](https://gitlab.com/gitlab-org/gitlab/-/issues/414673). +> - Support for consolidated object storage was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/149873) in GitLab 17.0. -### Object storage settings +Using the [consolidated form](object_storage.md#configure-a-single-storage-connection-for-all-object-types-consolidated-form) +of the object storage is recommended. + +### Storage-specific object storage The following settings are: @@ -120,7 +121,9 @@ The following settings are: See [the available connection settings for different providers](object_storage.md#configure-the-connection-settings). -**For Linux package installations:** +::Tabs + +:::TabTitle Linux package (Omnibus) 1. Edit `/etc/gitlab/gitlab.rb` and add the following lines, but using the values you want: @@ -147,10 +150,15 @@ See [the available connection settings for different providers](object_storage.m } ``` -1. Save the file and [reconfigure GitLab](restart_gitlab.md#reconfigure-a-linux-package-installation). +1. Save the file and reconfigure GitLab: + + ```shell + sudo gitlab-ctl reconfigure + ``` + 1. [Migrate any existing local states to the object storage](#migrate-to-object-storage). -**For self-compiled installations** +:::TabTitle Self-compiled (source) 1. Edit `/home/git/gitlab/config/gitlab.yml` and add or amend the following lines: @@ -167,9 +175,20 @@ See [the available connection settings for different providers](object_storage.m region: eu-central-1 ``` -1. Save the file and [restart GitLab](restart_gitlab.md#self-compiled-installations) for the changes to take effect. +1. Save the file and restart GitLab: + + ```shell + # For systems running systemd + sudo systemctl restart gitlab.target + + # For systems running SysV init + sudo service gitlab restart + ``` + 1. [Migrate any existing local states to the object storage](#migrate-to-object-storage). +::EndTabs + ### Migrate to object storage > - [Introduced](https://gitlab.com/gitlab-org/incubation-engineering/mobile-devops/readme/-/issues/125) in GitLab 16.1.