ff crd doc and todo cleanups

Signed-off-by: James Milligan <[email protected]>

Author: james-milligan

docs/README.md

@@ -10,8 +10,13 @@ Follow the documentation below to deploy the open feature operator to your local
 - [Getting Started](./getting_started.md)
 
 ## Configuration
+
+Configuration of the deployed sidecars is handled through the `FeatureFlagConfiguration` CRs defined in the `openfeature.dev/featureflagconfiguration` annotation of a deployed `PodSpec`. 
+> Configuration for the operator will be possible in the future, to help contribute [click here](https://github.com/open-feature/open-feature-operator/issues)
+
 - [Annotations](./annotations.md)
-- [Permissions](./permissions.md)
+- [FeatureFlagConfigurations](./feature_flag_configuration.md)
 
 ## Other Resources
-- [Architecture](./architecture.md)
+- [Architecture](./architecture.md)
+- [Permissions](./permissions.md)

docs/architecture.md

@@ -1,7 +1,6 @@
 # Architecture
 
 The high level architecture of the operator is as follows:  
-TODO: these annotations are wrong
 <p align="center">
     <img src="../images/arch-0.png" width="650">
 </p>

docs/feature_flag_configuration.md

@@ -0,0 +1,32 @@
+# Feature Flag Configuration
+
+The `FeatureFlagConfiguration` version `v1alpha2` CRD defines the a CR with the following example structure:
+
+```yaml
+apiVersion: core.openfeature.dev/v1alpha2
+kind: FeatureFlagConfiguration
+metadata:
+    name: featureflagconfiguration-sample
+spec:
+    flagDSpec:
+        envs:
+        - name: FLAGD_PORT
+          value: "8080"
+    featureFlagSpec: 
+        "flags": {
+            "foo": {
+                "state": "ENABLED",
+                "variants": {
+                    "bar": "BAR",
+                    "baz": "BAZ"
+                },
+                "defaultVariant": "bar"
+            }
+        }
+```
+
+Within the CRD there are 2 main objects, namely the `flagDSpec` and the `featureFlagSpec`, both offering a different set of configuration for the injected `flagd` sidecars.
+
+The `featureFlagSpec` is a json object representing the flag configurations themselves, the documentation for this object can be found [here](https://github.com/open-feature/flagd/blob/main/docs/configuration/flag_configuration.md).
+
+The `flagDSpec` has one property called `envs` which contains a list of environment variables used to override the default start command values in `flagd`, the documentation for this configuration can be found [here](https://github.com/open-feature/flagd/blob/main/docs/configuration/configuration.md).

docs/getting_started.md

@@ -85,7 +85,7 @@ kubectl describe pod busybox-curl-7bd5767999-spf7v
 
 Now that we have confirmed that the flagd sidecar has been injected and the configuration is correct we can test out the flag evaluation using curl.
 
-> This would not be the usual method for evaluating flags in our applications, instead a language specific flagd provider would be used in conjunction with the OpenFeature SDK, documentation can be found here (TODO: Flagd provider page or the doc website)
+> This would not be the usual method for evaluating flags in our applications, instead a language specific flagd provider would be used in conjunction with the OpenFeature SDK, documentation can be found [here](https://github.com/open-feature/flagd/blob/main/docs/usage/flagd_providers.md).
 
 ```
 kubectl exec -it busybox-curl-7bd5767999-spf7v sh

docs/installation.md

@@ -3,7 +3,8 @@
 
 ## Prerequisites
 
-Cert manager is required by the operator, the installation docs can be found [here](https://cert-manager.io/docs/installation/kubernetes/). (see why here TODO).
+OpenFeature Operator is a server that communicates with Kubernetes components within the cluster, as such it requires a means of authorizing requests between peers. Cert manager handles the authorization by adding certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates.
+The installation docs for cert manager can be found [here](https://cert-manager.io/docs/installation/kubernetes/).
 Alternatively, running the commands below will install cert manager into the `cert-manager` namespace.
 
 ```

docs/permissions.md

@@ -1,7 +1,5 @@
 # Permissions 
 
-TODO: these perms seem very permissive, might be worth investigating
-
 The open feature operator uses the `open-feature-operator-controller-manager` service account, this service account contains the following `RoleBindings`:
 - `open-feature-operator-leader-election-role` (role name: `leader-election-role`)
 - `open-feature-operator-manager-role` (role name: `manager-role`)