Skip to content

Commit

Permalink
docs(flagd-proxy): removed invalid grpc prefix from uri config
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
  • Loading branch information
beeme1mr authored Aug 2, 2024
1 parent ae24595 commit 4911697
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions flagd-proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ The kube flagd proxy acts as a pub sub for deployed flagd sidecar containers to
<img src="../images/flagd-proxy.png" width="650">
</p>
<!-- markdownlint-enable MD033 -->
On request, the flagd-proxy will spawn a goroutine to watch the CR using the `core` package kubernetes sync. Each further request for the same resource will add a new new stream to the broadcast list. Once all streams have been closed, and there are no longer any listeners for a given resource, the sync will be closed.
On request, the flagd-proxy will spawn a goroutine to watch the CR using the `core` package Kubernetes sync. Each further request for the same resource will add a new stream to the broadcast list. Once all streams have been closed and there are no longer any listeners for a given resource, the sync will be closed.

The flagd-proxy API follows the flagd grpc spec, found in the [buf schema registry](https://buf.build/open-feature/flagd), as such the existing grpc sync can be used to subscribe to the the CR changes.
The flagd-proxy API follows the flagd grpc spec, found in the [buf schema registry](https://buf.build/open-feature/flagd), as such the existing grpc sync can be used to subscribe to the CR changes.

## Deployment

Expand All @@ -21,7 +21,7 @@ kubectl create namespace flagd-proxy
kubectl apply -f ./config/deployments/flagd-proxy
```

Once the flagd-proxy has been deployed any flagd instance subscribe to flag changes using the grpc sync, providing the target resource uri using the `selector` configuration field.
Once the flagd-proxy has been deployed, any flagd instances subscribe to flag changes using the grpc sync, providing the target resource uri using the `selector` configuration field.

```yaml
apiVersion: v1
Expand All @@ -37,7 +37,7 @@ spec:
args:
- start
- --sources
- '[{"uri":"grpc://flagd-proxy-svc.flagd-proxy.svc.cluster.local:8015","provider":"grpc","selector":"core.openfeature.dev/NAMESPACE/NAME"}]'
- '[{"uri":"flagd-proxy-svc.flagd-proxy.svc.cluster.local:8015","provider":"grpc","selector":"core.openfeature.dev/NAMESPACE/NAME"}]'
- --debug
---
apiVersion: core.openfeature.dev/v1beta1
Expand All @@ -57,4 +57,4 @@ spec:
defaultVariant: yellow
```
Once deployed, the client flagd instance will be receiving almost instant flag configuration change events.
Once deployed, the client flagd instance will receive almost instant flag configuration change events.

0 comments on commit 4911697

Please sign in to comment.