document helm parameters

README.md

@@ -23,6 +23,7 @@ _kube-fledged_ provides CRUD APIs to manage the lifecycle of the image cache, an
 - [Quick Install using YAML manifests](#quick-install-using-yaml-manifests)
 - [Quick Install using Helm chart](#quick-install-using-helm-chart)
 - [Quick Install using Helm operator](#quick-install-using-helm-operator)
+- [Helm chart parameters](#helm-chart-parameters)
 - [Build and Deploy](#build-and-deploy)
   - [Build](#build)
   - [Deploy](#deploy)
@@ -126,6 +127,10 @@ These instructions install _kube-fledged_ to a separate namespace called "kube-f
   $ kubectl get imagecaches -n kube-fledged (Output should be: 'No resources found')
   ```
 
+## Helm chart parameters
+
+Parameters of the helm chart are documented [here](docs/helm-parameters.md)
+
 ## Build and Deploy
 
 These instructions will help you build _kube-fledged_ from source and deploy it to a separate namespace called "kube-fledged". If you need to deploy it to a different namespace, edit the namespace field of the manifests in "kube-fledged/deploy" accordingly.

docs/helm-parameters.md

@@ -0,0 +1,21 @@
+# Helm chart parameters
+
+| Parameter | Default value | Description |
+| --------- | ------------- | ----------- |
+| controllerReplicaCount    | 1        | No. of replicas of kubefledged-controller |
+| webhookServerReplicaCount | 1        | No. of replicas of kubefledged-webhook-server |
+| image.kubefledgedControllerRepository | docker.io/senthilrch/kubefledged-controller | Repository name of kubefledged-controller image |
+| image.kubefledgedCRIClientRepository | docker.io/senthilrch/kubefledged-cri-client | Repository name of kubefledged-cri-client image |
+| image.kubefledgedWebhookServerRepository | docker.io/senthilrch/kubefledged-webhook-server | Repository name of kubefledged-webhook-server image |
+| image.pullPolicy | Always | Image pull policy for kubefledged-controller and kubefledged-webhook-server pods |
+| args.controllerLogLevel | INFO | Log level of kubefledged-controller |
+| args.controllerImagePullDeadlineDuration | 5m | Maximum duration allowed for pulling an image. After this duration, image pull is considered to have failed |
+| args.controllerImageCacheRefreshFrequency | 15m | The image cache is refreshed periodically to ensure the cache is up to date. Setting this flag to "0s" will disable refresh |
+| args.controllerImagePullPolicy | IfNotPresent | Image pull policy for pulling images into and refreshing the cache. Possible values are 'IfNotPresent' and 'Always'. Default value is 'IfNotPresent'. Image with no or ":latest" tag are always pulled |
+| args.webhookServerLogLevel | INFO | Log level of kubefledged-webhook-server |
+| args.webhookServerCertFile | /var/run/secrets/webhook-server/tls.crt | Path of server certificate of kubefledged-webhook-server |
+| args.webhookServerKeyFile | /var/run/secrets/webhook-server/tls.key | Path of server key of kubefledged-webhook-server |
+| args.webhookServerPort | 443 | Listening port of kubefledged-webhook-server |
+| nameOverride | "" | nameOverride replaces the name of the chart in Chart.yaml, when this is used to construct Kubernetes object names |
+| fullnameOverride | "" | fullnameOverride completely replaces the generated name |
+|  |  |  |