Skip to content

Commit b2471b8

Browse files
djosephsenbeeme1mrtoddbaert
authored
docs: Add docs for s3 blobs (#1477)
## This PR Intent of this PR is to add the docs that were missing from #1449 ### Notes Happy holidays yall. --------- Signed-off-by: Dave Josephsen <[email protected]> Co-authored-by: Michael Beemer <[email protected]> Co-authored-by: Todd Baert <[email protected]>
1 parent a692b00 commit b2471b8

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docs/concepts/syncs.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,24 @@ flagd start --uri azblob://my-container/my-flags.json
9797

9898
In this example, assuming the environment variable AZURE_STORAGE_ACCOUNT is set to `myaccount`, and other options are not set, the service URL will be:
9999
`https://myaccount.blob.core.windows.net/my-container/my-flags.json`.
100-
This is expected be a valid service URL accessible by flagd (either by being public or together with environment variable credentials).
100+
This is expected to be a valid service URL accessible by flagd (either by being public or together with environment variable credentials).
101101
The polling interval can be configured.
102102
See [sync source](../reference/sync-configuration.md#source-configuration) configuration for details.
103103

104+
### S3 sync
105+
106+
The S3 sync provider fetches flags from an S3 bucket and periodically polls for flag definition updates.
107+
It uses [AWS standardized credentials chain](https://docs.aws.amazon.com/sdkref/latest/guide/standardized-credentials.html) to authorize the calls to AWS.
108+
109+
```shell
110+
flagd start --uri s3://my-bucket/my-flags.json
111+
```
112+
113+
In this example, `s3://my-bucket/my-flags.json` is expected to be a valid URI accessible by flagd
114+
(either by being public or together with the appropriate credentials read from a file or via the environment as described in the AWS docs linked above).
115+
The polling interval is configurable.
116+
See [sync source](../reference/sync-configuration.md#source-configuration) for details.
117+
104118
## Merging
105119

106120
Flagd can be configured to read from multiple sources at once, when this is the case flagd will merge all flag definition into a single

docs/reference/sync-configuration.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ it is passed to the correct implementation:
2020
| &nbsp;[grpc](#custom-grpc-target-uri) | `[ envoy \| dns \| uds\| xds ]://` | `envoy://localhost:9211/test.service` |
2121
| `gcs` | `gs://` | `gs://my-bucket/my-flags.json` |
2222
| `azblob` | `azblob://` | `azblob://my-container/my-flags.json` |
23+
| `s3` | `s3://` | `s3://my-bucket/my-flags.json` |
2324

2425
### Custom gRPC Target URI
2526

0 commit comments

Comments
 (0)