Skip to content

Commit 49ff1cf

Browse files
authored
fix: web and cli docs do not mention s3 (#1941)
See title. Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
1 parent f8173a4 commit 49ff1cf

5 files changed

Lines changed: 11 additions & 7 deletions

File tree

core/pkg/sync/builder/syncbuilder.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ func (sb *SyncBuilder) newAzblob(config sync.SourceConfig, logger *logger.Logger
268268

269269
func (sb *SyncBuilder) newS3(config sync.SourceConfig, logger *logger.Logger) *blobSync.Sync {
270270
// Extract bucket uri and object name from the full URI:
271-
// gs://bucket/path/to/object results in gs://bucket/ as bucketUri and
271+
// s3://bucket/path/to/object results in s3://bucket/ as bucketUri and
272272
// path/to/object as an object name.
273273
bucketURI := regS3.FindString(config.URI)
274274
objectName := regS3.ReplaceAllString(config.URI, "")

core/pkg/sync/builder/utils.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ func ParseSyncProviderURIs(uris []string) ([]sync.SourceConfig, error) {
8181
})
8282
default:
8383
return syncProvidersParsed, fmt.Errorf("invalid sync uri argument: %s, must start with 'file:', "+
84-
"'http(s)://', 'grpc(s)://', 'gs://', 'azblob://' or 'core.openfeature.dev'", uri)
84+
"'http(s)://', 'grpc(s)://', 'gs://', 'azblob://', 's3://' or 'core.openfeature.dev'", uri)
8585
}
8686
}
8787
return syncProvidersParsed, nil

docs/reference/flagd-cli/flagd_start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ flagd start [flags]
3535
--stream-deadline duration Set a server-side deadline for flagd sync and event streams (default 0, means no deadline).
3636
-g, --sync-port int32 gRPC Sync port (default 8015)
3737
-e, --sync-socket-path string Flagd sync service socket path. With grpc the sync service will be available on this address.
38-
-f, --uri .yaml/.yml/.json Set a sync provider uri to read data from, this can be a filepath, URL (HTTP and gRPC), FeatureFlag custom resource, or GCS or Azure Blob. When flag keys are duplicated across multiple providers the merge priority follows the index of the flag arguments, as such flags from the uri at index 0 take the lowest precedence, with duplicated keys being overwritten by those from the uri at index 1. Please note that if you are using filepath, flagd only supports files with .yaml/.yml/.json extension.
38+
-f, --uri .yaml/.yml/.json Set a sync provider uri to read data from, this can be a filepath, URL (HTTP and gRPC), FeatureFlag custom resource, or GCS, Azure Blob or S3. When flag keys are duplicated across multiple providers the merge priority follows the index of the flag arguments, as such flags from the uri at index 0 take the lowest precedence, with duplicated keys being overwritten by those from the uri at index 1. Please note that if you are using filepath, flagd only supports files with .yaml/.yml/.json extension.
3939
```
4040

4141
### Options inherited from parent commands

docs/reference/sync-configuration.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ Alternatively, these configurations can be passed to flagd via config file, spec
5050
| Field | Type | Note |
5151
| ------------------ | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5252
| uri | required `string` | Flag configuration source of the sync |
53-
| provider | required `string` | Provider type - `file`, `fsnotify`, `fileinfo`, `kubernetes`, `http`, `grpc`, `gcs` or `azblob` |
53+
| provider | required `string` | Provider type - `file`, `fsnotify`, `fileinfo`, `kubernetes`, `http`, `grpc`, `gcs`, `azblob` or `s3` |
5454
| authHeader | optional `string` | Used for http sync; set this to include the complete `Authorization` header value for any authentication scheme (e.g., "Bearer token_here", "Basic base64_credentials", etc.). |
55-
| interval | optional `uint32` | Used for http, gcs and azblob syncs; requests will be made at this interval. Defaults to 5 seconds. |
55+
| interval | optional `uint32` | Used for http, gcs, azblob and s3 syncs; requests will be made at this interval. Defaults to 5 seconds. |
5656
| tls | optional `boolean` | Enable/Disable secure TLS connectivity. Currently used only by gRPC sync. Default (ex: if unset) is false, which will use an insecure connection |
5757
| providerID | optional `string` | Value binds to grpc connection's providerID field. gRPC server implementations may use this to identify connecting flagd instance |
5858
| selector | optional `string` | Selector expression to filter flag configurations. Supports `source=<name>` and `flagSetId=<id>` syntax. See [selector syntax](selector-syntax.md) for details. |
@@ -86,6 +86,7 @@ Sync providers:
8686
- `grpc`(envoy) - envoy://localhost:9211/test.service
8787
- `gcs` - gs://my-bucket/my-flags.json
8888
- `azblob` - azblob://my-container/my-flags.json
89+
- `s3` - s3://my-bucket/my-flags.json
8990

9091
Startup command:
9192

@@ -103,7 +104,8 @@ Startup command:
103104
{"uri":"envoy://localhost:9211/test.service", "provider":"grpc"},
104105
{"uri":"my-flag-source:8080","provider":"grpc", "certPath": "/certs/ca.cert", "tls": true, "providerID": "flagd-weatherapp-sidecar", "selector": "flagSetId=weatherapp"},
105106
{"uri":"gs://my-bucket/my-flag.json","provider":"gcs"},
106-
{"uri":"azblob://my-container/my-flag.json","provider":"azblob"}]'
107+
{"uri":"azblob://my-container/my-flag.json","provider":"azblob"},
108+
{"uri":"s3://my-bucket/my-flag.json","provider":"s3"}]'
107109
```
108110

109111
Configuration file,
@@ -138,6 +140,8 @@ sources:
138140
provider: gcs
139141
- uri: azblob://my-container/my-flags.json
140142
provider: azblob
143+
- uri: s3://my-bucket/my-flags.json
144+
provider: s3
141145
```
142146
143147
### HTTP Configuration

flagd/cmd/start.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ func init() {
6464
flags.StringP(serverKeyPathFlagName, "k", "", "Server side tls key path")
6565
flags.StringSliceP(
6666
uriFlagName, "f", []string{}, "Set a sync provider uri to read data from, this can be a filepath,"+
67-
" URL (HTTP and gRPC), FeatureFlag custom resource, or GCS or Azure Blob. "+
67+
" URL (HTTP and gRPC), FeatureFlag custom resource, or GCS, Azure Blob or S3. "+
6868
"When flag keys are duplicated across multiple providers the "+
6969
"merge priority follows the index of the flag arguments, as such flags from the uri at index 0 take the "+
7070
"lowest precedence, with duplicated keys being overwritten by those from the uri at index 1. "+

0 commit comments

Comments
 (0)