Skip to content

adds azure storage examples and environment variable specifications #111

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

adds azure storage examples and environment variable specifications #111

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e8cb32
adds azure storage examples and environment variable specifications
askvinni Aug 29, 2025
2ef0166
remove signs
askvinni Aug 29, 2025
f59d954
codeblocks around azure env vars
askvinni Aug 29, 2025
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
33 changes: 33 additions & 0 deletions deployment/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,36 @@ these, for example:
* `file:///my/local/filesystem`
* `/my/local/filesystem`
* `gs://my-gcs-bucket`
* `https://mystorageaccount.blob.core.windows.net/my-bucket/path`
* `https://mystorageaccount.dfs.core.windows.net/my-bucket/path`
* `abfs://[email protected]/path`

Authentication with the underlying storage provider is usually expected through environment variables corresponding
to the cloud provider:

| Provider | Environment Variable | Description |
| ----- | ----------- | ------- |
| AWS | `AWS_ACCESS_KEY_ID` | access_key_id |
| AWS | `AWS_SECRET_ACCESS_KEY` | secret_access_key |
| AWS | `AWS_DEFAULT_REGION` | Region |
| AWS | `AWS_ENDPOINT` | Endpoint |
| AWS | `AWS_SESSION_TOKEN` | Token |
| AWS | `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` | https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html |
| AWS | `AWS_CONTAINER_CREDENTIALS_FULL_URI` | https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html |
| AWS | `AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE` | https://docs.aws.amazon.com/sdkref/latest/guide/feature-container-credentials.html |
| AWS | `AWS_ALLOW_HTTP` | Set to "true" to permit HTTP connections without TLS |
| AWS | `AWS_REQUEST_PAYER` | Set to "true" to permit operations on requester-pays buckets |
| Azure | `AZURE_STORAGE_ACCOUNT_NAME` | Storage account name |
| Azure | `AZURE_STORAGE_ACCOUNT_KEY` | Storage account master key |
| Azure | `AZURE_STORAGE_ACCESS_KEY` | Alias for AZURE_STORAGE_ACCOUNT_KEY |
| Azure | `AZURE_STORAGE_CLIENT_ID` | Client id for service principal authorization |
| Azure | `AZURE_STORAGE_CLIENT_SECRET` | Client secret for service principal authorization |
| Azure | `AZURE_STORAGE_TENANT_ID` | Tenant id used in oauth flows |
| GCS | `GOOGLE_SERVICE_ACCOUNT` | Location of service account file |
| GCS | `GOOGLE_SERVICE_ACCOUNT_PATH` | (Alias) Location of service account file |
| GCS | `SERVICE_ACCOUNT` | (Alias) Location of service account file |
| GCS | `GOOGLE_SERVICE_ACCOUNT_KEY` | JSON serialized service account key |
| GCS | `GOOGLE_BUCKET` | Bucket name |
| GCS | `GOOGLE_BUCKET_NAME` | (Alias) bucket name |
| R2 | `R2_ACCESS_KEY_ID` | access_key_id |
| R2 | `R2_SECRET_ACCESS_KEY` | secret_access_key |