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

Merged
merged 12 commits into from
Nov 6, 2024
2 changes: 2 additions & 0 deletions .cspell/en-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ checkoutservice
Chronosphere
classpath
cncf
configurator
comms
currencyservice
daemonset
Expand All @@ -40,6 +41,7 @@ EMEA
erlang
errorf
featureflagservice
flagd
frauddetectionservice
frontendproxy
github
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/demo/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ cartservice(Cart Service):::dotnet
checkoutservice(Checkout Service):::golang
currencyservice(Currency Service):::cpp
emailservice(Email Service):::ruby
flagd(Flagd-ui):::typescript
frauddetectionservice(Fraud Detection Service):::kotlin
frontend(Frontend):::typescript
frontendproxy(Frontend Proxy <br/>&#40Envoy&#41):::cpp
Expand All @@ -33,6 +34,7 @@ queue[(queue<br/>&#40Kafka&#41)]

Internet -->|HTTP| frontendproxy
frontendproxy -->|HTTP| frontend
frontendproxy -->|HTTP| flagd
loadgenerator -->|HTTP| frontendproxy
frontendproxy -->|HTTP| imageprovider

Expand Down
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
26 changes: 22 additions & 4 deletions content/en/docs/demo/feature-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,32 @@ aliases:
- feature_flags
- services/feature-flag
- services/featureflagservice
cSpell:ignore: flagd loadgenerator OLJCESPC7Z
cSpell:ignore: loadgenerator OLJCESPC7Z
---

The demo provides several feature flags that you can use to simulate different
scenarios. These flags are managed by [`flagd`](https://flagd.dev), a simple
feature flag service that supports [OpenFeature](https://openfeature.dev). Flag
values are stored in the `src/flagd/demo.flagd.json` file. To enable a flag,
change the `defaultVariant` value in the config file for a given flag to "on".
feature flag service that supports [OpenFeature](https://openfeature.dev).

Flag values can be changed through the user interface provided at
<http://localhost:8080/feature> when running the demo. Changing the values
through this user interface will be reflected in the flagd service.

There are two options when it comes to changing the feature flags through the
user interface:

- **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.

## Implemented feature flags

| Feature Flag | Service(s) | Description |
| ----------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------- |
Expand Down
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.

## 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.
6 changes: 6 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,9 @@ 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) |
1 change: 0 additions & 1 deletion content/en/docs/demo/telemetry-features/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: Telemetry Features
linkTitle: Telemetry Features
aliases: [demo_features, features]
cSpell:ignore: flagd
---

## OpenTelemetry
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/python/distro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: OpenTelemetry Distro
linkTitle: Distro
weight: 110
cSpell:ignore: configurator distro distros loglevel
cSpell:ignore: distro distros loglevel
---

In order to make using OpenTelemetry and auto-instrumentation as quick as
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/zero-code/php.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ title: PHP zero-code instrumentation
linkTitle: PHP
weight: 30
aliases: [/docs/languages/php/automatic]
# prettier-ignore
cSpell:ignore: centos configurator democlass epel myapp pecl phar remi unindented userland
cSpell:ignore: centos democlass epel myapp pecl phar remi unindented userland
---

## Requirements
Expand Down