Skip to content

Document S3 environment credential resolution #207

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

Open
fffinkel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document S3 environment credential resolution #207

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
32 changes: 32 additions & 0 deletions docs/reference/configuration/file-storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,38 @@ dt.file-storage.s3.secret-key=<secret-key>
dt.file-storage.s3.region=us-east-1
```

#### Authentication

The `s3` provider supports two credential modes.

**Static credentials.** Configure `dt.file-storage.s3.access-key` and `dt.file-storage.s3.secret-key`.
Both properties require each other. If you configure only one of them, Dependency-Track fails to start.
This mode works with any S3-compatible object store.

**Environment credentials.** Omit both properties. Dependency-Track resolves credentials from its
environment instead, using the first of these sources that provides them:

1. The `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
2. The shared AWS configuration file, `~/.aws/credentials` by default
3. IAM Roles for Service Accounts (IRSA) on Amazon EKS
4. Task roles on Amazon ECS
5. Instance profiles on Amazon EC2

```ini
dt.file-storage.provider=s3
dt.file-storage.s3.endpoint=https://s3.us-east-1.amazonaws.com
dt.file-storage.s3.bucket=dtrack-files
dt.file-storage.s3.region=us-east-1
```

Dependency-Track resolves credentials when it verifies the bucket during startup.
If no source provides credentials, startup fails.

!!! note
Amazon EKS Pod Identity is not supported. The S3 client does not read the token file that the
Pod Identity Agent provides, and it rejects the agent's endpoint because that address is not a
loopback address. Use IRSA on Amazon EKS.

Configuration:

- [`dt.file-storage.s3.endpoint`](properties.md#dtfile-storages3endpoint)
Expand Down