Documentation

Note

With version v0.5.0, we have migrated to API version v1beta1. Please check the migration guide to migrate from old configurations.

This directory contains OpenFeature Operator documentation.

Interested in having OpenFeature Operator up and running within 5 minutes? Follow the quick start guide found below.

• Quick Start

Follow the detailed installation guide to deploy open feature operator to your local cluster.

• Installation

Configuration

Configuration of the deployed sidecars is handled through the FeatureFlagSource custom resources referenced via openfeature.dev/featureflagsource annotations of the deployed PodSpec.

The relationship between the deployment and custom resources is highlighted in the diagram below,

Loading

flowchart TD
    A[Pod]-->|Annotation: openfeature.dev/featureflagsource| B[FeatureFlagSource CR]
    B--> |Flag source| C[FeatureFlag CR]
    B--> |Flag source| D[HTTP sync]
    B--> |Flag source| E[File sync]
    B--> |Flag source| F[GRPC sync]
    B--> |Flag source| G[flagd-proxy]

To configure and understand more,

• Deployment configurations: Annotations
• Define flag sources for the deployment: FeatureFlagSource
• Define feature flags as custom resource: FeatureFlags

Other Resources

• Permissions
• Concepts
• Development Notes
• Threat model
• flagd Kube Proxy
• API Reference