Skip to content

Commit 4d59bfb

Browse files
toddbaerttoddbaert
committed
fixup: more lint
Signed-off-by: Todd Baert <[email protected]>
1 parent 4566230 commit 4d59bfb

File tree

4 files changed

+42
-42
lines changed

4 files changed

+42
-42
lines changed

‎docs/concepts/selectors.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ When you make a request with a selector, flagd "reflects" the selector informati
119119
120120
**Request with selector:**
121121
122-
```
122+
```text
123123
Selector: "flagSetId=project-42"
124124
```
125125

‎docs/reference/selector-syntax.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Selectors use a simple key-value syntax to filter flags. Currently, selectors su
88

99
### Basic Syntax
1010

11-
```
11+
```text
1212
<key>=<value>
1313
```
1414

1515
### Backward Compatibility Syntax
1616

17-
```
17+
```text
1818
<value>
1919
```
2020

@@ -28,21 +28,21 @@ Selects flags belonging to a specific flag set.
2828

2929
**Syntax:**
3030

31-
```
31+
```text
3232
flagSetId=<set-identifier>
3333
```
3434

3535
**Examples:**
3636

37-
```
37+
```text
3838
flagSetId=project-42
3939
flagSetId=dev-environment
4040
flagSetId=team-payments
4141
```
4242

4343
**Special Case - Empty Flag Set:**
4444

45-
```
45+
```text
4646
flagSetId=
4747
```
4848

@@ -54,13 +54,13 @@ Selects flags from a specific source.
5454

5555
**Syntax:**
5656

57-
```
57+
```text
5858
source=<source-identifier>
5959
```
6060

6161
**Examples:**
6262

63-
```
63+
```text
6464
source=config/flags.json
6565
source=http://flag-server/config
6666
source=./local-flags.yaml
@@ -94,7 +94,7 @@ Flagd reflects selector information back in response metadata, providing transpa
9494

9595
**Input Selector:**
9696

97-
```
97+
```text
9898
flagSetId=project-42
9999
```
100100

‎docs/reference/specifications/providers.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ We always rely on the [integrated functionality of GRPC for reconnection](https:
106106
We are configuring the underlying reconnection mechanism whenever we can, based on our configuration. (not all GRPC implementations support this)
107107

108108
| language/property | min connect timeout | max backoff | initial backoff | jitter | multiplier |
109-
|-------------------|-----------------------------------|--------------------------|--------------------------|--------|------------|
109+
| ----------------- | --------------------------------- | ------------------------ | ------------------------ | ------ | ---------- |
110110
| GRPC property | grpc.initial_reconnect_backoff_ms | max_reconnect_backoff_ms | min_reconnect_backoff_ms | 0.2 | 1.6 |
111111
| Flagd property | deadlineMs | retryBackoffMaxMs | retryBackoffMs | 0.2 | 1.6 |
112112
| --- | --- | --- | --- | --- | --- |
@@ -262,28 +262,28 @@ precedence.
262262

263263
Below are the supported configuration parameters (note that not all apply to both resolver modes):
264264

265-
| Option name | Environment variable name | Explanation | Type & Values | Default | Compatible resolver |
266-
| --------------------- | ------------------------------ | ---------------------------------------------------------------------- | ---------------------------- | ----------------------------- | ----------------------- |
267-
| resolver | FLAGD_RESOLVER | mode of operation | String - `rpc`, `in-process` | rpc | rpc & in-process |
268-
| host | FLAGD_HOST | remote host | String | localhost | rpc & in-process |
269-
| port | FLAGD_PORT | remote port | int | 8013 (rpc), 8015 (in-process) | rpc & in-process |
270-
| targetUri | FLAGD_TARGET_URI | alternative to host/port, supporting custom name resolution | string | null | rpc & in-process |
271-
| tls | FLAGD_TLS | connection encryption | boolean | false | rpc & in-process |
272-
| socketPath | FLAGD_SOCKET_PATH | alternative to host port, unix socket | String | null | rpc & in-process |
273-
| certPath | FLAGD_SERVER_CERT_PATH | tls cert path | String | null | rpc & in-process |
274-
| deadlineMs | FLAGD_DEADLINE_MS | deadline for unary calls, and timeout for initialization | int | 500 | rpc & in-process & file |
275-
| streamDeadlineMs | FLAGD_STREAM_DEADLINE_MS | deadline for streaming calls, useful as an application-layer keepalive | int | 600000 | rpc & in-process |
276-
| retryBackoffMs | FLAGD_RETRY_BACKOFF_MS | initial backoff for stream retry | int | 1000 | rpc & in-process |
277-
| retryBackoffMaxMs | FLAGD_RETRY_BACKOFF_MAX_MS | maximum backoff for stream retry | int | 120000 | rpc & in-process |
278-
| retryGracePeriod | FLAGD_RETRY_GRACE_PERIOD | period in seconds before provider moves from STALE to ERROR state | int | 5 | rpc & in-process & file |
279-
| keepAliveTime | FLAGD_KEEP_ALIVE_TIME_MS | http 2 keepalive | long | 0 | rpc & in-process |
280-
| cache | FLAGD_CACHE | enable cache of static flags | String - `lru`, `disabled` | lru | rpc |
281-
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | max size of static flag cache | int | 1000 | rpc |
265+
| Option name | Environment variable name | Explanation | Type & Values | Default | Compatible resolver |
266+
| --------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | ---------------------------- | ----------------------------- | ----------------------- |
267+
| resolver | FLAGD_RESOLVER | mode of operation | String - `rpc`, `in-process` | rpc | rpc & in-process |
268+
| host | FLAGD_HOST | remote host | String | localhost | rpc & in-process |
269+
| port | FLAGD_PORT | remote port | int | 8013 (rpc), 8015 (in-process) | rpc & in-process |
270+
| targetUri | FLAGD_TARGET_URI | alternative to host/port, supporting custom name resolution | string | null | rpc & in-process |
271+
| tls | FLAGD_TLS | connection encryption | boolean | false | rpc & in-process |
272+
| socketPath | FLAGD_SOCKET_PATH | alternative to host port, unix socket | String | null | rpc & in-process |
273+
| certPath | FLAGD_SERVER_CERT_PATH | tls cert path | String | null | rpc & in-process |
274+
| deadlineMs | FLAGD_DEADLINE_MS | deadline for unary calls, and timeout for initialization | int | 500 | rpc & in-process & file |
275+
| streamDeadlineMs | FLAGD_STREAM_DEADLINE_MS | deadline for streaming calls, useful as an application-layer keepalive | int | 600000 | rpc & in-process |
276+
| retryBackoffMs | FLAGD_RETRY_BACKOFF_MS | initial backoff for stream retry | int | 1000 | rpc & in-process |
277+
| retryBackoffMaxMs | FLAGD_RETRY_BACKOFF_MAX_MS | maximum backoff for stream retry | int | 120000 | rpc & in-process |
278+
| retryGracePeriod | FLAGD_RETRY_GRACE_PERIOD | period in seconds before provider moves from STALE to ERROR state | int | 5 | rpc & in-process & file |
279+
| keepAliveTime | FLAGD_KEEP_ALIVE_TIME_MS | http 2 keepalive | long | 0 | rpc & in-process |
280+
| cache | FLAGD_CACHE | enable cache of static flags | String - `lru`, `disabled` | lru | rpc |
281+
| maxCacheSize | FLAGD_MAX_CACHE_SIZE | max size of static flag cache | int | 1000 | rpc |
282282
| selector | FLAGD_SOURCE_SELECTOR | Selector expression to filter flags (e.g., `flagSetId=my-app`, `source=config.json`) | string | null | in-process |
283-
| providerId | FLAGD_PROVIDER_ID | A unique identifier for flagd(grpc client) initiating the request. | string | null | in-process |
284-
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | offline, file-based flag definitions, overrides host/port/targetUri | string | null | file |
285-
| offlinePollIntervalMs | FLAGD_OFFLINE_POLL_MS | poll interval for reading offlineFlagSourcePath | int | 5000 | file |
286-
| contextEnricher | - | sync-metadata to evaluation context mapping function | function | identity function | in-process |
283+
| providerId | FLAGD_PROVIDER_ID | A unique identifier for flagd(grpc client) initiating the request. | string | null | in-process |
284+
| offlineFlagSourcePath | FLAGD_OFFLINE_FLAG_SOURCE_PATH | offline, file-based flag definitions, overrides host/port/targetUri | string | null | file |
285+
| offlinePollIntervalMs | FLAGD_OFFLINE_POLL_MS | poll interval for reading offlineFlagSourcePath | int | 5000 | file |
286+
| contextEnricher | - | sync-metadata to evaluation context mapping function | function | identity function | in-process |
287287

288288
### Custom Name Resolution
289289

‎docs/reference/sync-configuration.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,17 @@ The flagd accepts a string argument, which should be a JSON representation of an
4747

4848
Alternatively, these configurations can be passed to flagd via config file, specified using the `--config` flag.
4949

50-
| Field | Type | Note |
51-
| ----------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
52-
| uri | required `string` | Flag configuration source of the sync |
53-
| provider | required `string` | Provider type - `file`, `fsnotify`, `fileinfo`, `kubernetes`, `http`, `grpc`, `gcs` or `azblob` |
54-
| 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. |
56-
| 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 |
57-
| providerID | optional `string` | Value binds to grpc connection's providerID field. gRPC server implementations may use this to identify connecting flagd instance |
58-
| selector | optional `string` | Selector expression to filter flag configurations. Supports `source=<name>` and `flagSetId=<id>` syntax. See [selector syntax](selector-syntax.md) for details. |
59-
| certPath | optional `string` | Used for grpcs sync when TLS certificate is needed. If not provided, system certificates will be used for TLS connection |
60-
| maxMsgSize | optional `int` | Used for gRPC sync to set max receive message size (in bytes) e.g. 5242880 for 5MB. If not provided, the default is [4MB](https://pkg.go.dev/google.golang.org#grpc#MaxCallRecvMsgSize) |
50+
| Field | Type | Note |
51+
| ---------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
52+
| uri | required `string` | Flag configuration source of the sync |
53+
| provider | required `string` | Provider type - `file`, `fsnotify`, `fileinfo`, `kubernetes`, `http`, `grpc`, `gcs` or `azblob` |
54+
| 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. |
56+
| 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 |
57+
| providerID | optional `string` | Value binds to grpc connection's providerID field. gRPC server implementations may use this to identify connecting flagd instance |
58+
| selector | optional `string` | Selector expression to filter flag configurations. Supports `source=<name>` and `flagSetId=<id>` syntax. See [selector syntax](selector-syntax.md) for details. |
59+
| certPath | optional `string` | Used for grpcs sync when TLS certificate is needed. If not provided, system certificates will be used for TLS connection |
60+
| maxMsgSize | optional `int` | Used for gRPC sync to set max receive message size (in bytes) e.g. 5242880 for 5MB. If not provided, the default is [4MB](https://pkg.go.dev/google.golang.org#grpc#MaxCallRecvMsgSize) |
6161

6262
The `uri` field values **do not** follow the [URI patterns](#uri-patterns). The provider type is instead derived
6363
from the `provider` field. Only exception is the remote provider where `http(s)://` is expected by default. Incorrect

0 commit comments

Comments
 (0)