Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: update router storage-providers docs to include using IAM role for S3 authentication #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −1
Open

fix: update router storage-providers docs to include using IAM role for S3 authentication #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion router/storage-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ storage_providers:
bucket: "cosmo"
access_key: "key"
secret_key: "secret"
region: "use-east-1"
region: "us-east-1"
secure: false
```
{% endcode %}
Expand All @@ -45,6 +45,21 @@ storage_providers:
**secure** has to be set to `true` when you point to an S3 that uses **https://**
{% endhint %}

If you are using EC2 or EKS on AWS and have configured [`node IAM roles`](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) you don't need to provide an `access_key` or `secret_key` and the S3 client will handle this on your behalf.

{% code title="config.yaml" %}
```yaml
version: 1
storage_providers:
s3:
- id: "s3"
endpoint: "s3.amazonaws.com"
bucket: "cosmo"
region: "us-east-1"
secure: true
```
{% endcode %}

## Execution config

After configuring the storage provider, you can use it by referencing it in the `provider_id` field.
Expand Down