improve documentation

Author: 3schwartz

charts/openfga-operator/Chart.yaml

@@ -1,21 +1,9 @@
 apiVersion: v2
 name: openfga-operator
-description: A Helm chart for Kubernetes
-# A chart can be either an 'application' or a 'library' chart.
-#
-# Application charts are a collection of templates that can be packaged into versioned archives
-# to be deployed.
-#
-# Library charts provide useful utilities or functions for the chart developer. They're included as
-# a dependency of application charts to inject those utilities and functions into the rendering
-# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+description: |
+  A Helm chart for deploying the OpenFGA Operator on Kubernetes. 
+  The OpenFGA Operator manages and automates the deployment, 
+  scaling, and maintenance of OpenFGA instances.
 type: application
-# This is the chart version. This version number should be incremented each time you make changes
-# to the chart and its templates, including the app version.
-# Versions are expected to follow Semantic Versioning (https://semver.org/)
 version: 0.1.0
-# This is the version number of the application being deployed. This version number should be
-# incremented each time you make changes to the application. Versions are not expected to
-# follow Semantic Versioning. They should reflect the version the application is using.
-# It is recommended to use it with quotes.
 appVersion: "0.1.0"

charts/openfga-operator/values.yaml

@@ -1,32 +1,52 @@
+# Configuration for the OpenFGA Operator Controller Manager
 controllerManager:
+  # URL of the OpenFGA API
   openFgaUrl: 'http://openfga.default.svc.cluster.local:8080'
+  # API token for accessing the OpenFGA API using preshared keys.
   openFgaApiToken: foobar
+  
   manager:
+    # Arguments to pass to the controller manager
     args:
     - --leader-elect
     - --health-probe-bind-address=:8081
     - --metrics-bind-address=0
+    
+    # Security context for the controller manager container
     containerSecurityContext:
       allowPrivilegeEscalation: false
       capabilities:
         drop:
         - ALL
+        
+    # Image configuration for the controller manager
     image:
       repository: ghcr.io/3schwartz/openfga-operator
       tag: 9714871740
+      
+    # Resource requests and limits for the controller manager container
     resources:
       limits:
         cpu: 500m
         memory: 128Mi
       requests:
         cpu: 10m
         memory: 64Mi
+        
+  # Number of replicas for the controller manager
   replicas: 1
+  
+  # Service account configuration for the controller manager
   serviceAccount:
     annotations: {}
-  extraEnvVars: []
 
+  # Additional environment variables for the controller manager container
+  extraEnvVars: []
+
+# Kubernetes cluster domain
 kubernetesClusterDomain: cluster.local
+
+# Metrics service configuration
 metricsService:
   ports:
   - name: http