chore: fix file source documentation (#556)

Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com> Co-authored-by: Todd Baert <toddbaert@gmail.com>
open-feature · Nov 29, 2023 · 318c52d · 318c52d
1 parent ccb8c1d
commit 318c52d
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 19 deletions.
diff --git a/apis/core/v1beta1/featureflagsource_types.go b/apis/core/v1beta1/featureflagsource_types.go
@@ -115,7 +115,7 @@ type Source struct {
 	// Source is a URI of the flag sources
 	Source string `json:"source"`
 
-	// Provider type - kubernetes, http(s), grpc(s) or filepath
+	// Provider type - kubernetes, http(s), grpc(s) or file
 	// +optional
 	Provider common.SyncProviderType `json:"provider"`
 

diff --git a/chart/open-feature-operator/README.md b/chart/open-feature-operator/README.md
@@ -101,7 +101,7 @@ The command removes all the Kubernetes components associated with the chart and
 | `sidecarConfiguration.image.tag`           | Sets the version tag for the injected sidecar.                                                                                                                                                                                                              | `v0.7.0`                     |
 | `sidecarConfiguration.providerArgs`        | Used to append arguments to the sidecar startup command. This value is a comma separated string of key values separated by '=', e.g. `key=value,key2=value2` results in the appending of `--sync-provider-args key=value --sync-provider-args key2=value2`. | `""`                         |
 | `sidecarConfiguration.envVarPrefix`        | Sets the prefix for all environment variables set in the injected sidecar.                                                                                                                                                                                  | `FLAGD`                      |
-| `sidecarConfiguration.defaultSyncProvider` | Sets the value of the `XXX_SYNC_PROVIDER` environment variable for the injected sidecar container. There are 4 valid sync providers: `kubernetes`, `grpc`, `filepath` and `http`.                                                                           | `kubernetes`                 |
+| `sidecarConfiguration.defaultSyncProvider` | Sets the value of the `XXX_SYNC_PROVIDER` environment variable for the injected sidecar container. There are 4 valid sync providers: `kubernetes`, `grpc`, `file` and `http`.                                                                               | `kubernetes`                 |
 | `sidecarConfiguration.evaluator`           | Sets the value of the `XXX_EVALUATOR` environment variable for the injected sidecar container.                                                                                                                                                              | `json`                       |
 | `sidecarConfiguration.logFormat`           | Sets the value of the `XXX_LOG_FORMAT` environment variable for the injected sidecar container. There are 2 valid log formats: `json` and `console`.                                                                                                        | `json`                       |
 | `sidecarConfiguration.probesEnabled`       | Enable or Disable Liveness and Readiness probes of the flagd sidecar. When enabled, HTTP probes( paths - `/readyz`, `/healthz`) are set with an initial delay of 5 seconds.                                                                                 | `true`                       |

diff --git a/chart/open-feature-operator/values.yaml b/chart/open-feature-operator/values.yaml
@@ -21,7 +21,7 @@ sidecarConfiguration:
   providerArgs: ""
   ## @param sidecarConfiguration.envVarPrefix Sets the prefix for all environment variables set in the injected sidecar.
   envVarPrefix: "FLAGD"
-  ## @param sidecarConfiguration.defaultSyncProvider Sets the value of the `XXX_SYNC_PROVIDER` environment variable for the injected sidecar container. There are 4 valid sync providers: `kubernetes`, `grpc`, `filepath` and `http`.
+  ## @param sidecarConfiguration.defaultSyncProvider Sets the value of the `XXX_SYNC_PROVIDER` environment variable for the injected sidecar container. There are 4 valid sync providers: `kubernetes`, `grpc`, `file` and `http`.
   defaultSyncProvider: kubernetes
   ## @param sidecarConfiguration.evaluator Sets the value of the `XXX_EVALUATOR` environment variable for the injected sidecar container.
   evaluator: json

diff --git a/common/flagdinjector/flagdinjector.go b/common/flagdinjector/flagdinjector.go
@@ -280,8 +280,7 @@ func (fi *FlagdContainerInjector) toFilepathProviderConfig(ctx context.Context,
 	})
 
 	return types.SourceConfig{
-		URI: fmt.Sprintf("%s/%s", mountPath, utils.FeatureFlagConfigMapKey(ns, n)),
-		// todo - this constant needs to be aligned with flagd. We have a mixed usage of file vs filepath
+		URI:      fmt.Sprintf("%s/%s", mountPath, utils.FeatureFlagConfigMapKey(ns, n)),
 		Provider: "file",
 	}, nil
 }

diff --git a/config/crd/bases/core.openfeature.dev_featureflagsources.yaml b/config/crd/bases/core.openfeature.dev_featureflagsources.yaml
@@ -254,7 +254,7 @@ spec:
                       type: string
                     provider:
                       description: Provider type - kubernetes, http(s), grpc(s) or
-                        filepath
+                        file
                       type: string
                     providerID:
                       description: ProviderID is an identifier to be used in grpc

diff --git a/docs/README.md b/docs/README.md
@@ -21,7 +21,7 @@ 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[Filepath sync]
+    B--> |Flag source| E[File sync]
     B--> |Flag source| F[GRPC sync]
     B--> |Flag source| G[flagd-proxy]
 ```

diff --git a/docs/concepts.md b/docs/concepts.md
@@ -15,8 +15,7 @@ The high level architecture of the operator is as follows:
 
 - Kubernetes:  sync configuration that configures injected flagd sidecar instances to monitor the Kubernetes API 
   for changes in flag definition custom resources (`FeatureFlag`).
-- filepath:  sync configuration that creates and mounts ConfigMap files from flag configuration custom  resources
-  (`FeatureFlag`) and configures injected flagd sidecar instances to monitor them.
+- file:  sync configuration that creates and mounts ConfigMap files from flag configuration custom resources (`FeatureFlag`) and configures injected flagd sidecar instances to source them.
 - grpc: sync configuration that listens for flagd compatible grpc stream
 - http: sync configuration which watch and periodically poll flagd compatible http endpoint
 - [flagd-proxy](./flagd_proxy.md)
@@ -38,7 +37,7 @@ able to fetch Feature Flag information. For further information on how to avoid
 
 **When deploying an application via GitOps, we recommend using the `flagd-proxy` mode, which doesn't suffer from the shortcomings above.**
 
-The `"filepath"` provider requires no such communication, but relies on the fact that [Kubernetes automatically updates mounted ConfigMaps](https://kubernetes.io/docs/concepts/configuration/configmap/#mounted-configmaps-are-updated-automatically). 
+The `"file"` provider requires no such communication, but relies on the fact that [Kubernetes automatically updates mounted ConfigMaps](https://kubernetes.io/docs/concepts/configuration/configmap/#mounted-configmaps-are-updated-automatically). 
 The disadvantage of this approach is that flag configuration updates may take as long as two minutes to propagate, depending on cluster configuration:
 
 > "the total delay from the moment when the ConfigMap is updated to the moment when new keys are projected to the Pod can be as long as the kubelet sync period + cache propagation delay"

diff --git a/docs/crds.md b/docs/crds.md
@@ -403,7 +403,7 @@ FeatureFlagSourceSpec defines the desired state of FeatureFlagSource
         <td><b>provider</b></td>
         <td>string</td>
         <td>
-          Provider type - kubernetes, http(s), grpc(s) or filepath<br/>
+          Provider type - kubernetes, http(s), grpc(s) or file<br/>
         </td>
         <td>false</td>
       </tr><tr>

diff --git a/docs/feature_flag_source.md b/docs/feature_flag_source.md
@@ -44,15 +44,17 @@ This source type is useful when there is a need for restricting workload permiss
 
 Read more about proxy approach to access kubernetes resources: [flagd-proxy](./flagd_proxy.md)
 
-### filepath
+### file
 
-Injected sidecar can use volume mounted files as flag sources. 
-For this, provider type `filepath` is used as below example,
+In this mode, `FeatureFlag` custom resources are volume mounted to the injected flagd sidecar. 
+flagd then source flag configurations from this volume.
+
+For example, given `FeatureFlag` exist at `flags/sample-flags`, this source configuration look like below,
 
 ```yaml
 sources:                        
-  - source: /etc/flagd/config.json 
-    provider: filepath          
+  - source: flags/sample-flags
+    provider: file          
 ```
 
 ### http
@@ -125,7 +127,7 @@ spec:
     port: 80
     evaluator: json
     image: my-custom-sidecar-image
-    defaultSyncProvider: filepath
+    defaultSyncProvider: file
     tag: main
     sources:
     - source: namespace/name

diff --git a/docs/permissions.md b/docs/permissions.md
@@ -19,7 +19,9 @@ The definition of this role can be found [here](../config/rbac//leader_election_
 
 ### Manager Role
 
-The `manager-role` applies the rules described below, its definition can be found [here](../config/rbac/role.yaml). It provides the operator with sufficient permissions over the `core.openfeature.dev` resources, and the required permissions for injecting the `flagd` sidecar into appropriate pods. The `ConfigMap` permissions are needed to allow the mounting of `FeatureFlag` resources for filepath syncs.
+The `manager-role` applies the rules described below, its definition can be found [here](../config/rbac/role.yaml).
+It provides the operator with sufficient permissions over the `core.openfeature.dev` resources, and the required permissions for injecting the `flagd` sidecar into appropriate pods. 
+The `ConfigMap` permissions are needed to allow the mounting of `FeatureFlag` resources for file syncs.
 
 | API Group                   | Resource                              | Verbs                                           |
 |-----------------------------|---------------------------------------|-------------------------------------------------|

diff --git a/docs/threat_model.md b/docs/threat_model.md
@@ -110,7 +110,7 @@ flowchart LR
 
 `flagd` makes an authenticated http request to retrieve its initial flag configuration state from the CR. Subsequently, it registers an event handler to listen to changes to the CR. The configuration is at threat of information disclosure and tampering, the security control is authentication.
 
-##### filepath sync provider
+##### file sync provider
 
 ```mermaid
 flowchart LR