This guide helps to get OpenFeature Operator up and running with steps. You can skip to step 4 if you already have an Operator installation.
kind create cluster -n kind
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.3/cert-manager.yaml &&
kubectl wait --for=condition=Available=True deploy --all -n 'cert-manager'
[!NOTE] Requirement of this dependency is explained in the installation guide.
helm repo add openfeature https://open-feature.github.io/open-feature-operator/ &&
helm repo update &&
helm upgrade --install openfeature openfeature/open-feature-operator
kubectl create namespace open-feature-operator-system &&
kubectl apply -f https://github.com/open-feature/open-feature-operator/releases/download/v0.8.1/release.yaml
Next steps focus on adding feature flags, flag source configuration and a workload deployment
kubectl create ns flags
[!NOTE] We use the namespace
flagsfor flag related custom resources
This is added as a custom resource of kind FeatureFlag in flags namespace
kubectl apply -n flags -f - <<EOF
apiVersion: core.openfeature.dev/v1beta1
kind: FeatureFlag
metadata:
name: sample-flags
spec:
flagSpec:
flags:
foo:
state: "ENABLED"
variants:
"bar": "BAR"
"baz": "BAZ"
defaultVariant: "bar"
targeting: {}
EOF
This is added as a custom resource of kind FeatureFlagSource in flags namespace
kubectl apply -n flags -f - <<EOF
apiVersion: core.openfeature.dev/v1beta1
kind: FeatureFlagSource
metadata:
name: feature-flag-source
spec:
sources:
- source: flags/sample-flags
provider: kubernetes
port: 8080
EOF
Workload is deployed to namespace workload
kubectl create ns workload
The workload here is a simple busy box with curl support. Additionally, it contains OpenFeature Operator annotations.
kubectl apply -n workload -f - <<EOF
apiVersion: apps/v1
kind: Deployment
metadata:
name: busybox-curl
spec:
replicas: 1
selector:
matchLabels:
app: my-busybox-curl-app
template:
metadata:
labels:
app: my-busybox-curl-app
annotations:
# here are the annotations for OpenFeature Operator
openfeature.dev/enabled: "true"
openfeature.dev/featureflagsource: "flags/feature-flag-source"
spec:
containers:
- name: busybox
image: yauritux/busybox-curl:latest
ports:
- containerPort: 80
args:
- sleep
- "30000"
EOF
First, obtain the pod name of the workload,
kubectl get pods -n workload
This will yield pod name of our workload. For example, busybox-curl-784775c488-76cr9 as in below example output
NAME READY STATUS RESTARTS AGE
busybox-curl-784775c488-76cr9 2/2 Running 0 20h
Optional - you can further validate flagd sidecar by describing the pod and validating flagd container,
kubectl describe pod -n workload busybox-curl-784775c488-76cr9
Now with the pod name, exec into the pod,
kubectl exec --stdin --tty -n workload <POD_NAME> -- /bin/sh
Use the following curl command from the exec shell to evaluate a feature flag,
curl --location 'http://localhost:8080/schema.v1.Service/ResolveString' --header 'Content-Type: application/json' --data '{ "flagKey":"foo"}'
The output should be the following,
{"value":"BAR", "reason":"STATIC", "variant":"bar"}
This response is produced from flagd feature provider sidecar deployment, controlled by the operator and shows how operator pattern works end to end.
If you are facing errors or if things are not working,