Commit Graph

29 Commits

Author SHA1 Message Date
Michael Beemer ddfa0203ce
docs: add providerId as a configuration option (#1567)
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2025-03-27 12:28:07 -04:00
alexandraoberaigner e2203a13ca
fix: add support for unix socket connection in sync service (#1518) (#1560)
## This PR
adds support for unix sockets in sync service

### Related Issues
<!-- add here the GitHub issue that this PR resolves if applicable -->

Fixes #1518

### How to test
start flagd with the new option `-e /tmp/socketpath` and try to connect
with an in-process provider to the same socket path & request a flag

---------

Signed-off-by: Alexandra Oberaigner <alexandra.oberaigner@dynatrace.com>
Signed-off-by: alexandraoberaigner <82218944+alexandraoberaigner@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
2025-02-24 22:51:39 -05:00
Michael Beemer 57fcca7d92
docs: add rust provider
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2025-02-21 19:50:42 +00:00
katsumata(TK) cd3c3c6e4b
docs: fix url for flags.json (#1553)
Signed-off-by: katsumata <12413150+winor30@users.noreply.github.com>
2025-02-21 08:05:41 -05:00
Todd Baert b49abf9506
feat!: flagSetMetadata in OFREP/ResolveAll, core refactors (#1540)
⚠️ This PR brings a breaking change to the
[flagd-core](https://pkg.go.dev/github.com/open-feature/flagd/core)
library: the `IStore` interface now returns an additional value
representing the flag set metadata. There are no breaking changes in
flagd's behavior.

Changes in flagd:

- returns flag set metadata as metadata for error flags (best effort)
- returns flag set metadata in OFREP and RPC calls
- moves metadata merging logic to evaluator (all flags inherent flag set
metadata, but can override, as as before but now reusable in flagd core)
- removes duplicated flag set metadata keys when the same flag set
metadata key exists in multiple sources

### To Test

- requires `curl`, `grpcurl`, and `jq`

#### RPC

```shell
grpcurl -import-path  /...../schemas/protobuf/flagd/evaluation/v1  -proto evaluation.proto -plaintext  localhost:8013 flagd.evaluation.v1.Service/ResolveAll | jq
```

### OFREP

```shell
curl --location 'http://localhost:8016/ofrep/v1/evaluate/flags'  --header 'Content-Type: application/json' --data '{"context": {"color": "yellow"}}'  | jq
```

### Sync

```shell
grpcurl -import-path /...../schemas/protobuf/flagd/sync/v1/ -proto sync.proto -plaintext   localhost:8015 flagd.sync.v1.FlagSyncService/FetchAllFlags    | jq -r .flagConfiguration  | jq
```

---------

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2025-01-31 10:54:47 -05:00
Simon Schrottner f298866122
feat: migrate file evaluation to own provider type (#1525)
update of spec for https://github.com/open-feature/flagd/issues/1504

---------

Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
2025-01-28 08:02:28 +01:00
Todd Baert 6c78080c3c
docs: flag and flag-set metadata (#1505)
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2025-01-10 10:29:45 -05:00
Michael Beemer 9891df2d0c
chore: bump flagd-core in playground, add metadata example, fix doc links
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2025-01-07 20:52:31 +00:00
Simon Schrottner 35d286afab
feat(spec): from grace attempts to grace period, plus connection info (#1478)
updating specification based on findings in
https://github.com/open-feature/flagd/issues/1472

---------

Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
Co-authored-by: chrfwow <christian.lutnik@dynatrace.com>
2024-12-19 12:20:41 -05:00
Todd Baert f7dd1eb630
docs: fix copy-pasted requirement
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2024-12-04 14:49:35 -05:00
Todd Baert a19cb42373
docs: update flagd provider specs (#1432)
This PR contains significant enhancements to flagd provider specs. If
merged, I will be opening a bunch of issues to implement what's
described here based on recon I've been doing with the existing
implementations

Specifically:

- adds `retryGraceAttempts` param, which defines the amount of stream
retry attempts before provider moves from `STALE` to `ERROR` state
- adds `contextEnricher` param, which defines mapping function for
sync-metadata to evaluation context for in process providers (exists
already in Java provider)
- improves consistency between in-process and RPC stream reconnect
behavior
- simplifies provider doc and spec to remove duplication and improve
readability

---------

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Guido Breitenhuber <157148191+guidobrei@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2024-10-30 16:51:29 -04:00
Pradeep Mishra f716423422
docs: update gRPC custom resolver rfc proposal (#1421)
Signed-off-by: Pradeep <pradeepbbl@gmail.com>
2024-10-09 08:39:39 -04:00
Pradeep Mishra fb76af5830
docs: added gRPC custom name resolver proposal (#1414)
## This PR
Added initial gRPC custom name resolver draft proposal


- new proposal doc to support gRPC over proxy

### Related Issues
TBD

---------

Signed-off-by: Pradeep Mishra <pradeep.mishra@booking.com>
Signed-off-by: Pradeep <pradeepbbl@gmail.com>
Signed-off-by: Pradeep Mishra <pradeepbbl@users.noreply.github.com>
Signed-off-by: Pradeep Mishra <pradeepbbl@gmail.com>
Co-authored-by: Pradeep Mishra <pradeep.mishra@booking.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2024-10-01 12:05:27 -04:00
Florian Bacher f82c094f5c
feat: support relative weighting for fractional evaluation (#1313)
Closes #1282 

This PR adds support for using relative weights instead of percentages
that need to add up to 100.
The behavior for existing flag configs does not change with this PR, so
those will continue to work as they did previously

---------

Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
2024-06-27 12:50:34 -04:00
Todd Baert 0fc2d0a683
fix: submodules and doc (#1280)
Remove references to old protos, update `/schemas` submodule.

The old protos were still being used to generate the doc. I've updated
them. Also, the `schemas` submodule was set to some very old version, I
couldn't even run the live docs for that reason. I've updated it to the
latest release of that module.

---------

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2024-04-10 09:49:01 -04:00
Cole Bailey f62bc721e8
feat!: allow custom seed when using targetingKey override for fractional op (#1266)
<!-- Please use this template for your pull request. -->
<!-- Please use the sections that you need and delete other sections -->

## This PR
<!-- add the description of the PR here -->

- no longer injects flagKey as seed for fractional op when user has
provided custom targeting
- updates schema to allow `cat` and other operations so that custom
targeting can be properly seeded

### Related Issues
<!-- add here the GitHub issue that this PR resolves if applicable -->

https://github.com/open-feature/flagd/issues/1264

### Notes
<!-- any additional notes for this PR -->

### Follow-up Tasks
<!-- anything that is related to this PR but not done here should be
noted under this section -->
<!-- if there is a need for a new issue, please link it here -->

### How to test
<!-- if applicable, add testing instructions under this section -->

```bash
# unit tests
make test

# gherkin tests
./bin/flagd start -f file:test-harness/flags/testing-flags.json -f file:test-harness/flags/custom-ops.json -f file:test-harness/flags/evaluator-refs.json -f file:test-harness/flags/zero-flags.json
make flagd-integration-test
```

---------

Signed-off-by: Cole Bailey <cole.bailey@deliveryhero.com>
Signed-off-by: Cole Bailey <cole.bailey.one@gmail.com>
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
2024-04-09 08:41:41 -07:00
Todd Baert 6b8e954f96
docs: add targeting key doc/demo/spec (#1206)
Speccing this out and providing an example for maximum clarity.

New playground entry is last in the list:
https://deploy-preview-1206--polite-licorice-3db33c.netlify.app/playground/

New section:
https://deploy-preview-1206--polite-licorice-3db33c.netlify.app/reference/flag-definitions/#targeting-key

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2024-02-13 07:59:02 -05:00
Todd Baert ec634d94fc
chore: schema docs, add to all examples (#1181)
I've added a small page about the schema, and I've added the schema to
all examples.

Preview:
https://deploy-preview-1181--polite-licorice-3db33c.netlify.app/reference/schema/

---------

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2024-02-05 15:21:27 -08:00
Michael Beemer 99da3b7c54
docs: move OFO doc references (#1174)
## This PR

- adds redirects to appropriate OFO docs
- adds an OFO overview page

### Related Issues

Fixes #1055

### Notes

This PR removes most of the OFO docs so that we only have to maintain
content in a single location. In the future, it would be ideal if we
could include relative content automatically in the flagd docs, but that
was out of scope of this PR.

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
2024-01-31 11:49:55 -05:00
Michael Beemer 3efe321617
docs: add provider to the documentation (#1027)
## This PR

- adds a section on the install page that lists the available providers
- includes the readmes of the available providers

### How to test

- Install:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/installation/
- Overview Page:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/
- Go:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/go/
- Java:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/java/
- Node.JS:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/nodejs/
- PHP:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/php/
- .NET:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/dotnet/
- Web:
https://deploy-preview-1027--polite-licorice-3db33c.netlify.app/providers/web/

---------

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2024-01-12 17:26:05 -05:00
Todd Baert ca38c165c6
fix: various edge cases in targeting (#1041)
- returning variants from targeting which are not in the variants list is now an error
- minor spec changes

---------

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2023-12-05 09:04:25 -05:00
Michael Beemer 94d697724e
docs: change ecosystem link to use the correct case (#1025)
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2023-11-20 10:59:33 -05:00
odubajDT bb6f5bf0fc
feat!: support OFO v1beta1 API (#997)
BREAKING CHANGE: OFO APIs were updated to version v1beta1, since they are more stable now. Resources of the alpha versions are no longer supported in flagd or flagd-proxy.
2023-11-14 07:35:45 +01:00
Craig Pastro 608535a43f
docs: Add docs about $flag.properties (#965) 2023-10-14 10:10:37 -04:00
Todd Baert f3506abdf2
chore: adds meta descriptions to improve indexing/SEO/etc (#959)
I was looking into what we could do to improve our indexing and social
object graph. I don't think there's much except adding
meta-descriptions. These aren't as important as they used to be, but
they can still improve indexing and increase likelihood of sharing on
social media, etc.

Adding a markdown metadata section with `description` in mkdocs results
in it being used in the description meta tag for the page, so I've done
that for some pages that are likely to be searched.

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
2023-10-10 17:42:19 -04:00
Michael Beemer 0bade57400
docs: fixed typos and linting issues (#957)
## This PR

- reworked to autogenerated docs to resolve a relative path issue
- fixed invalid links
- fixed various typos

### How to test

Run `make run-web-docs` and look at the squeaky clean output.

---------

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2023-10-06 10:43:39 -04:00
Michael Beemer a281982baa
docs: fix link to provider ecosystem page (#947)
## This PR

- fix link to provider ecosystem page

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2023-10-04 13:35:12 -04:00
Michael Beemer 0089dc3122
docs: removed RPC section and fixed grammatical issues (#945)
## This PR

- remove RPC section from the in-process docs
- addressed various grammatical issues

---------

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
2023-09-29 10:56:36 -04:00
Todd Baert 27b3193821
chore: docs rework (#927)
Total web-docs overhaul:

- puts a helpful intro at the start, with a demo on the next page
- adds an "architecture" page which discusses in-process vs rpc
- adds a deployment page with mentions how to install/run
- adds a "reference" section which includes:
  - specs
  - protos (in the form of autogenerated markdown for easy navigation)
  - autogenerated CLI docs
- adds FAQ

---------

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
2023-09-27 13:46:39 -04:00