Skip to content

Commit bafc532

Browse files
committed
update docs
Signed-off-by: odubajDT <ondrej.dubaj@dynatrace.com>
1 parent 1b392bd commit bafc532

File tree

7 files changed

+40
-40
lines changed

7 files changed

+40
-40
lines changed

docs/concepts/syncs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ See [sync source](../reference/sync-configuration.md#source-configuration) confi
5050
### Kubernetes sync
5151

5252
The Kubernetes sync provider allows flagd to connect to a Kubernetes cluster and evaluate flags against a specified
53-
FeatureFlagConfiguration resource as defined within
54-
the [open-feature-operator](https://github.com/open-feature/open-feature-operator/blob/main/apis/core/v1alpha1/featureflagconfiguration_types.go)
53+
FeatureFlag resource as defined within
54+
the [open-feature-operator](https://github.com/open-feature/open-feature-operator/blob/main/apis/core/v1beta1/featureflag_types.go)
5555
spec.
5656
This configuration is best used in conjunction with the [OpenFeature Operator](https://github.com/open-feature/open-feature-operator).
5757

58-
To use an existing FeatureFlagConfiguration custom resource, start flagd with the following command:
58+
To use an existing FeatureFlag custom resource, start flagd with the following command:
5959

6060
```shell
6161
flagd start --uri core.openfeature.dev/default/my_example
6262
```
6363

64-
In this example, `default/my_example` expected to be a valid FeatureFlagConfiguration resource, where `default` is the
64+
In this example, `default/my_example` expected to be a valid FeatureFlag resource, where `default` is the
6565
namespace and `my_example` being the resource name.
6666
See [sync source](../reference/sync-configuration.md#source-configuration) configuration for details.
6767

docs/reference/openfeature-operator/crds/featureflagconfiguration.md renamed to docs/reference/openfeature-operator/crds/featureflag.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Feature Flag Configuration
22

3-
The `FeatureFlagConfiguration` version `v1alpha2` CRD defines a CR with the following example structure:
3+
The `FeatureFlag` version `v1beta1` CRD defines a CR with the following example structure:
44

55
```yaml
66
apiVersion: core.openfeature.dev/v1alpha2
7-
kind: FeatureFlagConfiguration
7+
kind: FeatureFlag
88
metadata:
9-
name: featureflagconfiguration-sample
9+
name: featureflag-sample
1010
spec:
1111
featureFlagSpec:
1212
flags:

docs/reference/openfeature-operator/crds/flagsourceconfiguration.md renamed to docs/reference/openfeature-operator/crds/featureflagsource.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# FlagSourceConfigurations
1+
# FeatureFlagSources
22

3-
`FlagSourceConfiguration` support multiple flag sources. Sources are configured as a list and given below are supported sources and their configurations,
3+
`FeatureFlagSource` support multiple flag sources. Sources are configured as a list and given below are supported sources and their configurations,
44

5-
## kubernetes aka `FeatureFlagConfiguration`
5+
## kubernetes aka `FeatureFlag`
66

7-
This is `FeatureFlagConfiguration` custom resource backed flagd feature flag definition.
8-
Read more on the custom resource at the dedicated documentation of [FeatureFlagConfiguration](https://github.com/open-feature/open-feature-operator/blob/main/docs/feature_flag_configuration.md)
7+
This is `FeatureFlag` custom resource backed flagd feature flag definition.
8+
Read more on the custom resource at the dedicated documentation of [FeatureFlag](https://github.com/open-feature/open-feature-operator/blob/main/docs/feature_flag_configuration.md)
99

10-
To refer this custom resource in `FlagSourceConfiguration`, provider type `kubernetes` is used as below example,
10+
To refer this custom resource in `FlagSource`, provider type `kubernetes` is used as below example,
1111

1212
```yaml
1313
sources:
14-
- source: flags/sample-flags # FeatureFlagConfiguration - namespace/custom_resource_name
15-
provider: kubernetes # kubernetes flag source backed by FeatureFlagConfiguration custom resource
14+
- source: flags/sample-flags # FeatureFlag - namespace/custom_resource_name
15+
provider: kubernetes # kubernetes flag source backed by FeatureFlag custom resource
1616
```
1717
1818
## flagd-proxy
1919
20-
`flagd-proxy` is an alternative to direct resource access on `FeatureFlagConfiguration` custom resources.
20+
`flagd-proxy` is an alternative to direct resource access on `FeatureFlag` custom resources.
2121
This source type is useful when there is a need for restricting workload permissions and/or to reduce k8s API load.
2222

2323
Read more about proxy approach to access kubernetes resources: [flagd-proxy](https://github.com/open-feature/open-feature-operator/blob/main/docs/flagd_proxy.md)
@@ -60,7 +60,7 @@ sources:
6060

6161
## Sidecar configurations
6262

63-
`FlagSourceConfiguration` further allows to provide configurations to the injected flagd sidecar.
63+
`FeatureFlagSource` further allows to provide configurations to the injected flagd sidecar.
6464
Table given below is non-exhaustive list of overriding options,
6565

6666
| Configuration | Explanation | Default |
@@ -82,16 +82,16 @@ If no namespace is provided, it is assumed that the CR is within the same namesp
8282
namespace: test-ns
8383
annotations:
8484
openfeature.dev/enabled: "true"
85-
openfeature.dev/flagsourceconfiguration: "config-A, test-ns-2/config-B"
85+
openfeature.dev/featureflagsource: "config-A, test-ns-2/config-B"
8686
```
8787

8888
In this example, 2 CRs are being used to configure the injected container (by default the operator uses the `flagd:main` image), `config-A` (which is assumed to be in the namespace `test-ns`) and `config-B` from the `test-ns-2` namespace, with `config-B` taking precedence in the configuration merge.
8989

90-
The `FlagSourceConfiguration` version `v1alpha3` CRD defines a CR with the following example structure, the documentation for this CRD can be found [here](https://github.com/open-feature/open-feature-operator/blob/main/docs/crds.md#flagsourceconfiguration):
90+
The `FeatureFlagSource` version `v1alpha3` CRD defines a CR with the following example structure, the documentation for this CRD can be found [here](https://github.com/open-feature/open-feature-operator/blob/main/docs/crds.md#featureflagsource):
9191

9292
```yaml
9393
apiVersion: core.openfeature.dev/v1alpha3
94-
kind: FlagSourceConfiguration
94+
kind: FeatureFlagSource
9595
metadata:
9696
name: flag-source-sample
9797
spec:
@@ -114,15 +114,15 @@ spec:
114114
debugLogging: false
115115
```
116116

117-
The relevant `FlagSourceConfigurations` are passed to the operator by setting the `openfeature.dev/flagsourceconfiguration` annotation, and is responsible for providing the full configuration of the injected sidecar.
117+
The relevant `FeatureFlagSources` are passed to the operator by setting the `openfeature.dev/featureflagsource` annotation, and is responsible for providing the full configuration of the injected sidecar.
118118

119119
## Configuration Merging
120120

121-
When multiple `FlagSourceConfigurations` are provided, the configurations are merged. The last `CR` takes precedence over the first, with any configuration from the deprecated `FlagDSpec` field of the `FeatureFlagConfiguration` CRD taking the lowest priority.
121+
When multiple `FeatureFlagSources` are provided, the configurations are merged. The last `CR` takes precedence over the first, with any configuration from the deprecated `FlagDSpec` field of the `FeatureFlag` CRD taking the lowest priority.
122122

123123
```mermaid
124124
flowchart LR
125-
FlagSourceConfiguration-values -->|highest priority| environment-variables -->|lowest priority| defaults
125+
FeatureFlagSource-values -->|highest priority| environment-variables -->|lowest priority| defaults
126126
```
127127

128128
An example of this behavior:
@@ -131,14 +131,14 @@ An example of this behavior:
131131
metadata:
132132
annotations:
133133
openfeature.dev/enabled: "true"
134-
openfeature.dev/flagsourceconfiguration:"config-A, config-B"
134+
openfeature.dev/featureflagsource:"config-A, config-B"
135135
```
136136

137137
Config-A:
138138

139139
```yaml
140140
apiVersion: core.openfeature.dev/v1alpha2
141-
kind: FlagSourceConfiguration
141+
kind: FeatureFlagSource
142142
metadata:
143143
name: config-A
144144
spec:
@@ -150,7 +150,7 @@ Config-B:
150150

151151
```yaml
152152
apiVersion: core.openfeature.dev/v1alpha2
153-
kind: FlagSourceConfiguration
153+
kind: FeatureFlagSource
154154
metadata:
155155
name: config-B
156156
spec:

docs/reference/openfeature-operator/installation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ Create a namespace to house your flags:
2727
kubectl create namespace flags
2828
```
2929

30-
Next, define your feature flag(s) using the [FeatureFlagConfiguration](./crds/featureflagconfiguration.md) custom resource definition (CRD).
30+
Next, define your feature flag(s) using the [FeatureFlag](./crds/featureflag.md) custom resource definition (CRD).
3131

3232
This example specifies one flag called `foo` which has two variants `bar` and `baz`. The `defaultVariant` is `bar`.
3333

3434
```bash
3535
kubectl apply -n flags -f - <<EOF
36-
apiVersion: core.openfeature.dev/v1alpha2
37-
kind: FeatureFlagConfiguration
36+
apiVersion: core.openfeature.dev/v1beta1
37+
kind: FeatureFlag
3838
metadata:
3939
name: sample-flags
4040
spec:
@@ -52,18 +52,18 @@ EOF
5252

5353
Next, tell the OpenFeature operator where to find flags.
5454

55-
Do so by creating a [FlagSourceConfiguration](./crds/flagsourceconfiguration.md) CRD.
55+
Do so by creating a [FeatureFlagSource](./crds/featureflagsource.md) CRD.
5656

5757
This example specifies that the CRD called `sample-flags` (created above) can be found in the `flags` namespace and that the provider is `kubernetes`.
5858

5959
The `port` parameter defines the port on which the flagd API will be made available via the sidecar (more on this below).
6060

6161
```bash
6262
kubectl apply -n flags -f - <<EOF
63-
apiVersion: core.openfeature.dev/v1alpha3
64-
kind: FlagSourceConfiguration
63+
apiVersion: core.openfeature.dev/v1beta1
64+
kind: FeatureFlagSource
6565
metadata:
66-
name: flag-source-configuration
66+
name: feature-flag-source
6767
spec:
6868
sources:
6969
- source: flags/sample-flags
@@ -77,11 +77,11 @@ EOF
7777
The operator looks for `Deployment` objects annotated with particular annotations.
7878

7979
- `openfeature.dev/enabled: "true"` enables this deployment for flagd
80-
- `openfeature.dev/flagsourceconfiguration: "flags/flag-source-configuration"` makes the given feature flag sources available to this deployment
80+
- `openfeature.dev/featureflagsource: "flags/feature-flag-source"` makes the given feature flag sources available to this deployment
8181

8282
When these two annotations are added, the OpenFeature operator will inject a sidecar into your workload.
8383

84-
flagd will then be available via `http://localhost` the port specified in the `FlagSourceConfiguration` (e.g. `8080`)
84+
flagd will then be available via `http://localhost` the port specified in the `FeatureFlagSource` (e.g. `8080`)
8585

8686
Your Deployment YAML might look like this:
8787

@@ -102,7 +102,7 @@ spec:
102102
annotations:
103103
# here are the annotations for OpenFeature Operator
104104
openfeature.dev/enabled: "true"
105-
openfeature.dev/flagsourceconfiguration: "flags/flag-source-configuration"
105+
openfeature.dev/featureflagsource: "flags/feature-flag-source"
106106
spec:
107107
containers:
108108
- name: busybox

docs/reference/specifications/in-process-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ in-process flagd provider via a gRPC client connection to a sync server, such as
2121

2222
An implementation of an in-process flagd-provider must accept the following environment variables which determine the sync source:
2323

24-
- `FLAGD_SOURCE_URI`: The URI identifying the sync source. Depending on the sync provider type, this can be the URI of a gRPC service providing the `sync` API required by the in-process flagd provider, or the name of a [core.openfeature.dev/v1alpha2.FeatureFlagConfiguration](https://github.com/open-feature/open-feature-operator/blob/main/docs/crds.md#featureflagconfiguration-1) Custom Resource containing the flag definition.
24+
- `FLAGD_SOURCE_URI`: The URI identifying the sync source. Depending on the sync provider type, this can be the URI of a gRPC service providing the `sync` API required by the in-process flagd provider, or the name of a [core.openfeature.dev/v1beta1.FeatureFlag](https://github.com/open-feature/open-feature-operator/blob/main/docs/crds.md#featureflag-1) Custom Resource containing the flag definition.
2525
- `FLAGD_SOURCE_PROVIDER_TYPE`: The type of the provider. E.g. `grpc` or `kubernetes`.
2626
- `FLAGD_SOURCE_SELECTOR`: Optional selector for the feature flag definition of interest. This is used as a `selector` for the flagd-proxie's sync API to identify a flag definition within a collection of feature flag definitions.
2727

flagd-proxy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![experimental](http://badges.github.io/stability-badges/dist/experimental.svg)](http://github.com/badges/stability-badges)
44

5-
The kube flagd proxy acts as a pub sub for deployed flagd sidecar containers to subscribe to change events in FeatureFlagConfiguration CRs.
5+
The kube flagd proxy acts as a pub sub for deployed flagd sidecar containers to subscribe to change events in FeatureFlag CRs.
66
<!-- markdownlint-disable MD033 -->
77
<p align="center">
88
<img src="../images/flagd-proxy.png" width="650">

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ nav:
9292
- 'String Comparison Specification': 'reference/specifications/custom-operations/string-comparison-operation-spec.md'
9393
- 'OpenFeature Operator':
9494
- 'Installation': 'reference/openfeature-operator/installation.md'
95-
- 'FeatureFlagConfiguration': 'reference/openfeature-operator/crds/featureflagconfiguration.md'
96-
- 'FlagSourceConfiguration': 'reference/openfeature-operator/crds/flagsourceconfiguration.md'
95+
- 'FeatureFlag': 'reference/openfeature-operator/crds/featureflag.md'
96+
- 'FeatureFlagSource': 'reference/openfeature-operator/crds/featureflagsource.md'
9797
- 'Naming': 'reference/naming.md'
9898
- 'FAQ': 'faq.md'
9999
- 'Troubleshooting': 'troubleshooting.md'

0 commit comments

Comments
 (0)