You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/openfeature-operator/crds/featureflagsource.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,23 @@
1
-
# FlagSourceConfigurations
1
+
# FeatureFlagSources
2
2
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,
4
4
5
-
## kubernetes aka `FeatureFlagConfiguration`
5
+
## kubernetes aka `FeatureFlag`
6
6
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)
9
9
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,
provider: kubernetes # kubernetes flag source backed by FeatureFlag custom resource
16
16
```
17
17
18
18
## flagd-proxy
19
19
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.
21
21
This source type is useful when there is a need for restricting workload permissions and/or to reduce k8s API load.
22
22
23
23
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:
60
60
61
61
## Sidecar configurations
62
62
63
-
`FlagSourceConfiguration`further allows to provide configurations to the injected flagd sidecar.
63
+
`FeatureFlagSource`further allows to provide configurations to the injected flagd sidecar.
64
64
Table given below is non-exhaustive list of overriding options,
65
65
66
66
| Configuration | Explanation | Default |
@@ -82,16 +82,16 @@ If no namespace is provided, it is assumed that the CR is within the same namesp
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.
89
89
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):
91
91
92
92
```yaml
93
93
apiVersion: core.openfeature.dev/v1alpha3
94
-
kind: FlagSourceConfiguration
94
+
kind: FeatureFlagSource
95
95
metadata:
96
96
name: flag-source-sample
97
97
spec:
@@ -114,15 +114,15 @@ spec:
114
114
debugLogging: false
115
115
```
116
116
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.
118
118
119
119
## Configuration Merging
120
120
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.
Copy file name to clipboardExpand all lines: docs/reference/specifications/in-process-providers.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ in-process flagd provider via a gRPC client connection to a sync server, such as
21
21
22
22
An implementation of an in-process flagd-provider must accept the following environment variables which determine the sync source:
23
23
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.
25
25
-`FLAGD_SOURCE_PROVIDER_TYPE`: The type of the provider. E.g. `grpc` or `kubernetes`.
26
26
-`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.
0 commit comments