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.

Sign up for GitHub

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

Jump to bottom

docs: replace make deploy-demo command with a link to the cloud-native-demo repo #476

Merged
merged 1 commit into from
Apr 24, 2023
Merged

docs: replace make deploy-demo command with a link to the cloud-native-demo repo #476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 2 additions & 20 deletions docs/getting_started.md
View file
Open in desktop
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