Skip to content

Commit 0554336

Browse files
committed
Update local operator docs
1 parent 9cbfa7f commit 0554336

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
![version](https://img.shields.io/badge/version-pre--alpha-green)
66
![status](https://img.shields.io/badge/status-not--for--production-red)
77

8-
98
The open-feature-operator is a Kubernetes native operator that allows you to expose feature flags to your applications. It injects a [flagd](https://github.com/open-feature/flagd) sidecar into your pod and allows you to poll the flagd server for feature flags in a variety of ways.
109

1110
### Architecture
@@ -15,12 +14,12 @@ High level architecture is as follows:
1514

1615
<img src="images/arch-0.png" width="560">
1716

18-
1917
### Example
2018

2119
When wishing to leverage featureflagging within the local pod, the following steps are required:
2220

2321
1. Create a new feature flag custom resource e.g.
22+
2423
```
2524
apiVersion: core.openfeature.dev/v1alpha1
2625
kind: FeatureFlagConfiguration
@@ -30,10 +29,11 @@ spec:
3029
featureFlagSpec: |
3130
{
3231
"foo" : "bar"
33-
}
32+
}
3433
```
3534

3635
2. Reference the CR within the pod spec annotations
36+
3737
```
3838
apiVersion: v1
3939
kind: Pod
@@ -56,17 +56,18 @@ spec:
5656
root@nginx:/# curl localhost:8080
5757
{
5858
"foo" : "bar"
59-
}
59+
}
6060
```
6161

62-
### Running the operator locally
62+
### Running the operator locally
6363

64-
1. Create a local cluster with MicroK8s or Kind
65-
2. `kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.0/cert-manager.yaml`
66-
3. `kubectl apply -f config/webhook/certificate.yaml`
67-
4. `IMG=ghcr.io/open-feature/open-feature-operator:main make deploy`
64+
1. Create a local cluster with MicroK8s or Kind
65+
1. `kubectl create ns 'open-feature-operator-system'`
66+
1. `kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.8.0/cert-manager.yaml`
67+
1. `kubectl apply -f config/webhook/certificate.yaml`
68+
1. `IMG=ghcr.io/open-feature/open-feature-operator:main make deploy`
6869

6970
#### Run the example
7071

71-
1. `kubectl apply -f config/samples/featureflagconfiguration-sample.yaml`
72-
2. `kubectl apply -f config/samples/pod.yaml`
72+
1. `kubectl apply -f config/samples/config_v1alpha1_featureflagconfiguration.yaml`
73+
1. `kubectl apply -f config/samples/pod.yaml`

0 commit comments

Comments
 (0)