Skip to content

Commit

Permalink
docs: replace make deploy-demo command with a link to the `cloud-na…
Browse files Browse the repository at this point in the history
…tive-demo` repo (#476)

Signed-off-by: James Milligan <james@omnant.co.uk>
  • Loading branch information
james-milligan authored Apr 24, 2023
1 parent 013761a commit fff12a8
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,8 @@ Once you [understand the basic concepts](./concepts.md) and [install the operato

### Deploy the demo app

To get started with the operator you can deploy our e2e example using the [playground app](https://github.com/open-feature/playground)
To deploy the example, run the following command:
```sh
make deploy-demo
```
This command deploys the demo app to the `open-feature-demo` namespace, and once it enters a `Ready` state, will start port-forwarding to the deployed `service/open-feature-demo-service`. Once the log line `Forwarding from 127.0.0.1:30000 -> 30000` is printed, the application is available at [`127.0.0.1:30000`](127.0.0.1:30000).

To update the flag configurations first request the deployed yaml from the cluster, writing it to a file:
```
kubectl get featureflagconfigurations.core.openfeature.dev end-to-end -o yaml > my-flag-configuration.yaml
```
This file can then be edited and re-applied to the cluster, resulting in the changes being reflected by the demo application. As an example, change the `defaultVariant` for the `hex-color` flag from `"blue"` to `"green"`.
Run `kubectl apply -f my-flag-configuration.yaml` to apply these changes to the cluster, this will result in the background color of the demo app changing to green when the `flagd` provider is selected.

### Uninstall the demo app

To uninstall the demo app from your cluster, run the following command:
```
make delete-demo-deployment
```
To get started with the operator you can deploy our e2e example using the [cloud-native-demo](https://github.com/open-feature/cloud-native-demo), showcasing an integration with ArgoCD to control feature flags in a GitOps environment.
Alternatively, you can deploy your own application following the guide below.

## Deploy your own application

Expand Down

0 comments on commit fff12a8

Please sign in to comment.