open-feature
/
flagd
mirror of https://github.com/open-feature/flagd.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(flagd-proxy): removed invalid grpc prefix from uri config 

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
This commit is contained in:
Michael Beemer 2024-08-02 10:58:00 -04:00 committed by GitHub
parent ae2459504f
commit 4911697ab1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
flagd-proxy/README.md
View File

@ -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"> <img src="../images/flagd-proxy.png" width="650">
</p> </p>
<!-- markdownlint-enable MD033 --> <!-- 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 ## Deployment
@ -21,7 +21,7 @@ kubectl create namespace flagd-proxy
kubectl apply -f ./config/deployments/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 ```yaml
apiVersion: v1 apiVersion: v1
@ -37,7 +37,7 @@ spec:
args: args:
- start - start
- --sources - --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 - --debug
--- ---
apiVersion: core.openfeature.dev/v1beta1 apiVersion: core.openfeature.dev/v1beta1
@ -57,4 +57,4 @@ spec:
defaultVariant: yellow 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.