Commit e8d86f72 authored by Evan Read's avatar Evan Read Committed by Marcel Amirault

Clarify use IAM profile feature docs

parent 6957a03d
...@@ -163,7 +163,7 @@ configuration. ...@@ -163,7 +163,7 @@ configuration.
#### Encrypted S3 buckets #### Encrypted S3 buckets
> Introduced in [GitLab 13.1](https://gitlab.com/gitlab-org/gitlab-workhorse/-/merge_requests/466) only for instance profiles. > Introduced in [GitLab 13.1](https://gitlab.com/gitlab-org/gitlab-workhorse/-/merge_requests/466) for instance profiles only.
When configured to use an instance profile, GitLab Workhorse When configured to use an instance profile, GitLab Workhorse
will properly upload files to S3 buckets that have [SSE-S3 or SSE-KMS will properly upload files to S3 buckets that have [SSE-S3 or SSE-KMS
...@@ -185,14 +185,29 @@ that properly computes and sends the `Content-MD5` header to the server, ...@@ -185,14 +185,29 @@ that properly computes and sends the `Content-MD5` header to the server,
which eliminates the need for comparing ETag headers. If the data is which eliminates the need for comparing ETag headers. If the data is
corrupted in transit, the S3 server will reject the file. corrupted in transit, the S3 server will reject the file.
##### Disabling the feature
The Workhorse S3 client is enabled by default when the
[`use_iam_profile` configuration option](#iam-permissions) is set to `true`.
The feature can be disabled using the `:use_workhorse_s3_client` feature flag. To disable the
feature, ask a GitLab administrator with
[Rails console access](feature_flags.md#how-to-enable-and-disable-features-behind-flags) to run the
following command:
```ruby
Feature.disable(:use_workhorse_s3_client)
```
#### IAM Permissions #### IAM Permissions
To set up an instance profile, create an Amazon Identity Access and To set up an instance profile:
Management (IAM) role with the necessary permissions. The following
example is a role for an S3 bucket named `test-bucket`: 1. Create an Amazon Identity Access and Management (IAM) role with the necessary permissions. The
following example is a role for an S3 bucket named `test-bucket`:
```json ```json
{ {
"Version": "2012-10-17", "Version": "2012-10-17",
"Statement": [ "Statement": [
{ {
...@@ -207,22 +222,11 @@ example is a role for an S3 bucket named `test-bucket`: ...@@ -207,22 +222,11 @@ example is a role for an S3 bucket named `test-bucket`:
"Resource": "arn:aws:s3:::test-bucket/*" "Resource": "arn:aws:s3:::test-bucket/*"
} }
] ]
} }
``` ```
Associate this role with your GitLab instance, and then configure GitLab
to use it via the `use_iam_profile` configuration option. For example,
when configuring uploads to use object storage, see the `AWS IAM profiles`
section in [S3 compatible connection settings](uploads.md#s3-compatible-connection-settings).
#### Disabling the feature
The Workhorse S3 client is only enabled when the `use_iam_profile`
configuration flag is `true`.
To disable this feature, ask a GitLab administrator with [Rails console access](feature_flags.md#how-to-enable-and-disable-features-behind-flags) to run the
following command:
```ruby 1. [Attach this role](https://aws.amazon.com/premiumsupport/knowledge-center/attach-replace-ec2-instance-profile/)
Feature.disable(:use_workhorse_s3_client) to the EC2 instance hosting your GitLab instance.
``` 1. Configure GitLab to use it via the `use_iam_profile` configuration option. For example, when
configuring uploads to use object storage, see the `AWS IAM profiles` section in
[S3-compatible connection settings](uploads.md#s3-compatible-connection-settings).
...@@ -70,7 +70,7 @@ For source installations the following settings are nested under `uploads:` and ...@@ -70,7 +70,7 @@ For source installations the following settings are nested under `uploads:` and
| `proxy_download` | Set to true to enable proxying all files served. Option allows to reduce egress traffic as this allows clients to download directly from remote storage instead of proxying all data | `false` | | `proxy_download` | Set to true to enable proxying all files served. Option allows to reduce egress traffic as this allows clients to download directly from remote storage instead of proxying all data | `false` |
| `connection` | Various connection options described below | | | `connection` | Various connection options described below | |
### S3 compatible connection settings ### S3-compatible connection settings
The connection settings match those provided by [Fog](https://github.com/fog), and are as follows: The connection settings match those provided by [Fog](https://github.com/fog), and are as follows:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment