Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Flagd-ui to demo docs #5332

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions content/en/docs/demo/docker-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ Once the images are built and containers are started you can access:
- Jaeger UI: <http://localhost:8080/jaeger/ui/>
- Tracetest UI: <http://localhost:11633/>, only when using
`make run-tracetesting`
- Flagd configurator UI: <http://localhost:8080/feature>

## Changing the demo's primary port number

Expand Down
18 changes: 18 additions & 0 deletions content/en/docs/demo/feature-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,21 @@ Please see the [flagd documentation](https://flagd.dev) for more information on
how flagd works, and the [OpenFeature](https://openfeature.dev) website for more
information on how OpenFeature works, along with documentation for the
OpenFeature API.

## Flagd configurator

Flag values can be changed through the ui provided at <http://localhost:8080/feature> when running the demo. Changing the
svrnm marked this conversation as resolved.
Show resolved Hide resolved
values through this ui will be reflected in the flagd service.
svrnm marked this conversation as resolved.
Show resolved Hide resolved

There are two options when it comes to changing the feature flags through the ui:
svrnm marked this conversation as resolved.
Show resolved Hide resolved

### Basic view

A user friendly view in which default variants (the same options that need to be changed when configuring through the
raw file) can be selected and saved for each feature flag. Currently, the basic view does not support fractional targeting.

### Advanced view

A view in which the raw configuration json file is loaded and can be edited within the browser. The view provides the
flexibility that comes with editing a raw json file, however it also provides schema checking to ensure that the
json is valid and that the provided configuration values are correct.
svrnm marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions content/en/docs/demo/kubernetes-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ With the frontendproxy port-forward set up, you can access:
- Grafana: <http://localhost:8080/grafana/>
- Load Generator UI: <http://localhost:8080/loadgen/>
- Jaeger UI: <http://localhost:8080/jaeger/ui/>
- Flagd configurator UI: <http://localhost:8080/feature>

### Expose Demo components using service or ingress configurations

Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/demo/requirements/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ application written in Swift.
Feature flagging is a crucial part of cloud native application development. The
demo uses OpenFeature, a CNCF incubating project, to manage feature flags.

Feature flags can be set through the Flagd configurator user interface.
svrnm marked this conversation as resolved.
Show resolved Hide resolved

## Orchestration and Deployment

All services should run on Kubernetes. The OpenTelemetry Collector should be
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions content/en/docs/demo/screenshots/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,10 @@ aliases: [demo_screenshots]
## Load Generator UI

![load-generator-ui](load-generator-ui.png)

## Flagd Configurator

| Basic view | Advanced view |
| ---------------------------------------------------- | ---------------------------------------------------------- |
| ![flagd-ui-basic-view](flagd-configurator-basic.png) | ![flagd-ui-advanced-view](flagd-configurator-advanced.png) |