Skip to content

Commit e3ae3a2

Browse files
Add Flagd-ui to demo docs (#5332)
Co-authored-by: Juliano Costa <[email protected]> Co-authored-by: Juliano Costa <[email protected]>
1 parent 24dbe7a commit e3ae3a2

File tree

12 files changed

+38
-8
lines changed

12 files changed

+38
-8
lines changed

.cspell/en-words.txt

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ checkoutservice
2626
Chronosphere
2727
classpath
2828
cncf
29+
configurator
2930
comms
3031
currencyservice
3132
daemonset
@@ -40,6 +41,7 @@ EMEA
4041
erlang
4142
errorf
4243
featureflagservice
44+
flagd
4345
frauddetectionservice
4446
frontendproxy
4547
github

content/en/docs/demo/architecture.md

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ cartservice(Cart Service):::dotnet
1919
checkoutservice(Checkout Service):::golang
2020
currencyservice(Currency Service):::cpp
2121
emailservice(Email Service):::ruby
22+
flagd(Flagd-ui):::typescript
2223
frauddetectionservice(Fraud Detection Service):::kotlin
2324
frontend(Frontend):::typescript
2425
frontendproxy(Frontend Proxy <br/>&#40Envoy&#41):::cpp
@@ -33,6 +34,7 @@ queue[(queue<br/>&#40Kafka&#41)]
3334
3435
Internet -->|HTTP| frontendproxy
3536
frontendproxy -->|HTTP| frontend
37+
frontendproxy -->|HTTP| flagd
3638
loadgenerator -->|HTTP| frontendproxy
3739
frontendproxy -->|HTTP| imageprovider
3840

content/en/docs/demo/docker-deployment.md

+1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ Once the images are built and containers are started you can access:
7171
- Jaeger UI: <http://localhost:8080/jaeger/ui/>
7272
- Tracetest UI: <http://localhost:11633/>, only when using
7373
`make run-tracetesting`
74+
- Flagd configurator UI: <http://localhost:8080/feature>
7475

7576
## Changing the demo's primary port number
7677

content/en/docs/demo/feature-flags.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,32 @@ aliases:
44
- feature_flags
55
- services/feature-flag
66
- services/featureflagservice
7-
cSpell:ignore: flagd loadgenerator OLJCESPC7Z
7+
cSpell:ignore: loadgenerator OLJCESPC7Z
88
---
99

1010
The demo provides several feature flags that you can use to simulate different
1111
scenarios. These flags are managed by [`flagd`](https://flagd.dev), a simple
12-
feature flag service that supports [OpenFeature](https://openfeature.dev). Flag
13-
values are stored in the `src/flagd/demo.flagd.json` file. To enable a flag,
14-
change the `defaultVariant` value in the config file for a given flag to "on".
12+
feature flag service that supports [OpenFeature](https://openfeature.dev).
13+
14+
Flag values can be changed through the user interface provided at
15+
<http://localhost:8080/feature> when running the demo. Changing the values
16+
through this user interface will be reflected in the flagd service.
17+
18+
There are two options when it comes to changing the feature flags through the
19+
user interface:
20+
21+
- **Basic View**: A user friendly view in which default variants (the same
22+
options that need to be changed when configuring through the raw file) can be
23+
selected and saved for each feature flag. Currently, the basic view does not
24+
support fractional targeting.
25+
26+
- **Advanced View**: A view in which the raw configuration JSON file is loaded
27+
and can be edited within the browser. The view provides the flexibility that
28+
comes with editing a raw JSON file, however it also provides schema checking
29+
to ensure that the JSON is valid and that the provided configuration values
30+
are correct.
31+
32+
## Implemented feature flags
1533

1634
| Feature Flag | Service(s) | Description |
1735
| ----------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------- |

content/en/docs/demo/kubernetes-deployment.md

+1
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ With the frontendproxy port-forward set up, you can access:
7474
- Grafana: <http://localhost:8080/grafana/>
7575
- Load Generator UI: <http://localhost:8080/loadgen/>
7676
- Jaeger UI: <http://localhost:8080/jaeger/ui/>
77+
- Flagd configurator UI: <http://localhost:8080/feature>
7778

7879
### Expose Demo components using service or ingress configurations
7980

content/en/docs/demo/requirements/architecture.md

+2
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ application written in Swift.
7171
Feature flagging is a crucial part of cloud native application development. The
7272
demo uses OpenFeature, a CNCF incubating project, to manage feature flags.
7373

74+
Feature flags can be set through the flagd configurator user interface.
75+
7476
## Orchestration and Deployment
7577

7678
All services should run on Kubernetes. The OpenTelemetry Collector should be
Loading
Loading

content/en/docs/demo/screenshots/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,9 @@ aliases: [demo_screenshots]
3333
## Load Generator UI
3434

3535
![load-generator-ui](load-generator-ui.png)
36+
37+
## Flagd Configurator
38+
39+
| Basic view | Advanced view |
40+
| ---------------------------------------------------- | ---------------------------------------------------------- |
41+
| ![flagd-ui-basic-view](flagd-configurator-basic.png) | ![flagd-ui-advanced-view](flagd-configurator-advanced.png) |

content/en/docs/demo/telemetry-features/_index.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: Telemetry Features
33
linkTitle: Telemetry Features
44
aliases: [demo_features, features]
5-
cSpell:ignore: flagd
65
---
76

87
## OpenTelemetry

content/en/docs/languages/python/distro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: OpenTelemetry Distro
33
linkTitle: Distro
44
weight: 110
5-
cSpell:ignore: configurator distro distros loglevel
5+
cSpell:ignore: distro distros loglevel
66
---
77

88
In order to make using OpenTelemetry and auto-instrumentation as quick as

content/en/docs/zero-code/php.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ title: PHP zero-code instrumentation
33
linkTitle: PHP
44
weight: 30
55
aliases: [/docs/languages/php/automatic]
6-
# prettier-ignore
7-
cSpell:ignore: centos configurator democlass epel myapp pecl phar remi unindented userland
6+
cSpell:ignore: centos democlass epel myapp pecl phar remi unindented userland
87
---
98

109
## Requirements

0 commit comments

Comments
 (0)