chore: Updated chart docs

charts/fluent-bit-aggregator/README.md

@@ -25,7 +25,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install fluent-bit-aggregator oci://ghcr.io/stevehipwell/helm-charts/fluent-bit-aggregator --version 0.11.0
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/
@@ -41,7 +41,7 @@ helm upgrade --install fluent-bit-aggregator stevehipwell/fluent-bit-aggregator
 | autoscaling.behavior | object | `{}` | Behaviour configuration for the `HorizontalPodAutoscaler`. |
 | autoscaling.enabled | bool | `false` | If `true`, create a `HorizontalPodAutoscaler` to scale the `StatefulSet`. |
 | autoscaling.maxReplicas | int | `3` | Maximum number of replicas for the `HorizontalPodAutoscaler`. |
-| autoscaling.metrics | list | `[]` | Metrics configuration for the `HorizontalPodAutoscaler`. |
+| autoscaling.metrics | list | See _values.yaml_ | Metrics configuration for the `HorizontalPodAutoscaler`. |
 | autoscaling.minReplicas | int | `1` | Minimum number of replicas for the `HorizontalPodAutoscaler`. |
 | command | list | `["/fluent-bit/bin/fluent-bit"]` | Command for the default container |
 | commonLabels | object | `{}` | Labels to add to all chart resources. |
@@ -68,9 +68,9 @@ helm upgrade --install fluent-bit-aggregator stevehipwell/fluent-bit-aggregator
 | image.repository | string | `"cr.fluentbit.io/fluent/fluent-bit"` | Image repository for the default container. |
 | image.tag | string | `nil` | Image tag for the default container, this will default to `.Chart.AppVersion` if not set and will be omitted if set to `-`. |
 | imagePullSecrets | list | `[]` | Image pull secrets. |
-| ingresses | list | `[]` | Ingresses, each input plugin will need it's own. |
+| ingresses | list | See _values.yaml_ | Ingresses, each input plugin will need it's own. |
 | livenessProbe | object | See _values.yaml_ | Liveness probe configuration for the default container. |
-| minReadySeconds | string | `nil` | Min ready seconds for the `StatefulSet`. |
+| minReadySeconds | int | `nil` | Min ready seconds for the `StatefulSet`. |
 | nameOverride | string | `nil` | Override the name of the chart. |
 | nodeSelector | object | `{}` | Node labels to match for pod scheduling. |
 | ordinals | object | `{}` | Ordinals configuration for the `StatefulSet`. |
@@ -92,7 +92,7 @@ helm upgrade --install fluent-bit-aggregator stevehipwell/fluent-bit-aggregator
 | rbac.additionalRules | list | `[]` | Additional rules to add to the `ClusterRole`. |
 | rbac.create | bool | `false` | If `true`, create a `ClusterRole` & `ClusterRoleBinding` with access to the Kubernetes API. |
 | readinessProbe | object | See _values.yaml_ | Readiness probe configuration for the default container. |
-| replicas | int | `1` | Number of replicas to create if `autoscalling.enabled` is `false`. |
+| replicas | int | `1` | Number of replicas to create if `autoscaling.enabled` is `false`. |
 | resources | object | `{}` | Resources for the default container. |
 | securityContext | object | See _values.yaml_ | Security context for the default container. |
 | service.additionalPorts | list | See _values.yaml_ | Additional ports to expose. |
@@ -108,7 +108,7 @@ helm upgrade --install fluent-bit-aggregator stevehipwell/fluent-bit-aggregator
 | serviceMonitor.additionalLabels | object | `{}` | Additional labels for the `ServiceMonitor`. |
 | serviceMonitor.enabled | bool | `false` | If `true`, create a `ServiceMonitor` resource to support the _Prometheus Operator_. |
 | serviceMonitor.endpointConfig | object | `{}` | Additional endpoint configuration for the default `ServiceMonitor` endpoint. |
-| terminationGracePeriodSeconds | string | `nil` | Termination grace period for the pod in seconds. |
+| terminationGracePeriodSeconds | int | `nil` | Termination grace period for the pod in seconds. |
 | tolerations | list | `[]` | Node taints which will be tolerated for pod scheduling. |
 | topologySpreadConstraints | list | `[]` | Topology spread constraints for pod scheduling. If an explicit label selector is not provided one will be created from the pod selector labels. |
 | updateStrategy | object | `{}` | Update strategy for the `StatefulSet`. |

charts/fluent-bit-aggregator/README.md.gotmpl

@@ -19,7 +19,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install {{ template "chart.name" . }} oci://ghcr.io/stevehipwell/helm-charts/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/

charts/fluent-bit-aggregator/values.yaml

@@ -57,7 +57,8 @@ service:
       containerPort: 24224
       protocol: TCP
 
-# -- Ingresses, each input plugin will need it's own.
+# -- (list) Ingresses, each input plugin will need it's own.
+# @default -- See _values.yaml_
 ingresses: []
 #  - servicePort: 24224
 #    className: my-ingress-class
@@ -72,7 +73,7 @@ ingresses: []
 #          - chart-example.local
 #        secretName: chart-example-tls
 
-# -- Number of replicas to create if `autoscalling.enabled` is `false`.
+# -- Number of replicas to create if `autoscaling.enabled` is `false`.
 replicas: 1
 
 autoscaling:
@@ -84,7 +85,8 @@ autoscaling:
   maxReplicas: 3
   # -- Behaviour configuration for the `HorizontalPodAutoscaler`.
   behavior: {}
-  # -- Metrics configuration for the `HorizontalPodAutoscaler`.
+  # -- (list) Metrics configuration for the `HorizontalPodAutoscaler`.
+  # @default -- See _values.yaml_
   metrics: []
   #  - type: Resource
   #    resource:
@@ -102,7 +104,7 @@ ordinals: {}
 # -- Pod management policy for the `StatefulSet`.
 podManagementPolicy:
 
-# -- Min ready seconds for the `StatefulSet`.
+# -- (int) Min ready seconds for the `StatefulSet`.
 minReadySeconds:
 
 podDisruptionBudget:
@@ -127,10 +129,10 @@ podSecurityContext:
   seccompProfile:
     type: RuntimeDefault
 
-# -- Priority class name for the pod.
+# -- (string) Priority class name for the pod.
 priorityClassName:
 
-# -- Termination grace period for the pod in seconds.
+# -- (int) Termination grace period for the pod in seconds.
 terminationGracePeriodSeconds:
 
 # -- Security context for the default container.

charts/fluent-bit-collector/README.md

@@ -25,7 +25,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install fluent-bit-collector oci://ghcr.io/stevehipwell/helm-charts/fluent-bit-collector --version 0.8.0
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/
@@ -67,7 +67,7 @@ helm upgrade --install fluent-bit-collector stevehipwell/fluent-bit-collector --
 | image.tag | string | `nil` | Image tag for the default container, this will default to `.Chart.AppVersion` if not set and will be omitted if set to `-`. |
 | imagePullSecrets | list | `[]` | Image pull secrets. |
 | livenessProbe | object | See _values.yaml_ | Liveness probe configuration for the default container. |
-| minReadySeconds | string | `nil` | Min ready seconds for the `DaemonSet`. |
+| minReadySeconds | int | `nil` | Min ready seconds for the `DaemonSet`. |
 | nameOverride | string | `nil` | Override the name of the chart. |
 | nodeSelector | object | `{}` | Node labels to match for pod scheduling. |
 | podAnnotations | object | `{}` | Annotations to add to the pod. |
@@ -92,7 +92,7 @@ helm upgrade --install fluent-bit-collector stevehipwell/fluent-bit-collector --
 | serviceMonitor.additionalLabels | object | `{}` | Additional labels for the `ServiceMonitor`. |
 | serviceMonitor.enabled | bool | `false` | If `true`, create a `ServiceMonitor` (or `PodMonitor` if the Service isn't enabled) resource to support the _Prometheus Operator_. |
 | serviceMonitor.endpointConfig | object | `{}` | Additional endpoint configuration for the default `ServiceMonitor` endpoint. |
-| terminationGracePeriodSeconds | string | `nil` | Termination grace period for the pod in seconds. |
+| terminationGracePeriodSeconds | int | `nil` | Termination grace period for the pod in seconds. |
 | tolerations | list | `[]` | Node taints which will be tolerated for pod scheduling. |
 | updateStrategy | object | `{}` | Update strategy for the `DaemonSet`. |
 

charts/fluent-bit-collector/README.md.gotmpl

@@ -19,7 +19,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install {{ template "chart.name" . }} oci://ghcr.io/stevehipwell/helm-charts/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/

charts/fluent-bit-collector/values.yaml

@@ -60,7 +60,7 @@ service:
 # -- Update strategy for the `DaemonSet`.
 updateStrategy: {}
 
-# -- Min ready seconds for the `DaemonSet`.
+# -- (int) Min ready seconds for the `DaemonSet`.
 minReadySeconds:
 
 # -- Labels to add to the pod.
@@ -77,10 +77,10 @@ podSecurityContext:
   seccompProfile:
     type: RuntimeDefault
 
-# -- Priority class name for the pod.
+# -- (string) Priority class name for the pod.
 priorityClassName:
 
-# -- Termination grace period for the pod in seconds.
+# -- (int) Termination grace period for the pod in seconds.
 terminationGracePeriodSeconds:
 
 # -- Security context for the default container.

charts/fluentd-aggregator/README.md

@@ -26,7 +26,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install fluentd-aggregator oci://ghcr.io/stevehipwell/helm-charts/fluentd-aggregator --version 4.1.2
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/
@@ -42,7 +42,7 @@ helm upgrade --install fluentd-aggregator stevehipwell/fluentd-aggregator --vers
 | autoscaling.behavior | object | `{}` | Behaviour configuration for the `HorizontalPodAutoscaler`. |
 | autoscaling.enabled | bool | `false` | If `true`, create a `HorizontalPodAutoscaler` to scale the `StatefulSet`. |
 | autoscaling.maxReplicas | int | `3` | Maximum number of replicas for the `HorizontalPodAutoscaler`. |
-| autoscaling.metrics | list | `[]` | Metrics configuration for the `HorizontalPodAutoscaler`. |
+| autoscaling.metrics | list | See _values.yaml_ | Metrics configuration for the `HorizontalPodAutoscaler`. |
 | autoscaling.minReplicas | int | `1` | Minimum number of replicas for the `HorizontalPodAutoscaler`. |
 | commonLabels | object | `{}` | Labels to add to all chart resources. |
 | config.filters | string | See _values.yaml_ | Fluentd filter configuration. |
@@ -62,9 +62,9 @@ helm upgrade --install fluentd-aggregator stevehipwell/fluentd-aggregator --vers
 | image.tag | string | `nil` | Image tag for the default container, this will default to `.Chart.AppVersion` if not set and will be omitted if set to `-`. |
 | image.tagPrefix | string | `nil` | Tag prefix for the default container. |
 | imagePullSecrets | list | `[]` | Image pull secrets. |
-| ingresses | list | `[]` | Ingresses, each input plugin will need it's own. |
+| ingresses | list | See _values.yaml_ | Ingresses, each input plugin will need it's own. |
 | livenessProbe | object | See _values.yaml_ | Liveness probe configuration for the default container. |
-| minReadySeconds | string | `nil` | Min ready seconds for the `StatefulSet`. |
+| minReadySeconds | int | `nil` | Min ready seconds for the `StatefulSet`. |
 | nameOverride | string | `nil` | Override the name of the chart. |
 | nodeSelector | object | `{}` | Node labels to match for pod scheduling. |
 | ordinals | object | `{}` | Ordinals configuration for the `StatefulSet`. |
@@ -86,7 +86,7 @@ helm upgrade --install fluentd-aggregator stevehipwell/fluentd-aggregator --vers
 | podSecurityContext | object | See _values.yaml_ | Security context for the pod. |
 | priorityClassName | string | `nil` | Priority class name for the pod. |
 | readinessProbe | object | See _values.yaml_ | Readiness probe configuration for the default container. |
-| replicas | int | `1` | Number of replicas to create if `autoscalling.enabled` is `false`. |
+| replicas | int | `1` | Number of replicas to create if `autoscaling.enabled` is `false`. |
 | resources | object | `{}` | Resources for the default container. |
 | securityContext | object | See _values.yaml_ | Security context for the default container. |
 | service.additionalPorts | list | See _values.yaml_ | Additional ports to expose. |
@@ -103,7 +103,7 @@ helm upgrade --install fluentd-aggregator stevehipwell/fluentd-aggregator --vers
 | serviceMonitor.additionalLabels | object | `{}` | Additional labels for the `ServiceMonitor`. |
 | serviceMonitor.enabled | bool | `false` | If `true`, create a `ServiceMonitor` resource to support the _Prometheus Operator_. |
 | serviceMonitor.endpointConfig | object | `{}` | Additional endpoint configuration for the default `ServiceMonitor` endpoint. |
-| terminationGracePeriodSeconds | string | `nil` | Termination grace period for the pod in seconds. |
+| terminationGracePeriodSeconds | int | `nil` | Termination grace period for the pod in seconds. |
 | tolerations | list | `[]` | Node taints which will be tolerated for pod scheduling. |
 | topologySpreadConstraints | list | `[]` | Topology spread constraints for pod scheduling. If an explicit label selector is not provided one will be created from the pod selector labels. |
 | updateStrategy | object | `{}` | Update strategy for the `StatefulSet`. |

charts/fluentd-aggregator/README.md.gotmpl

@@ -19,7 +19,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install {{ template "chart.name" . }} oci://ghcr.io/stevehipwell/helm-charts/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/

charts/fluentd-aggregator/values.yaml

@@ -57,7 +57,8 @@ service:
   # -- If `true`, use legacy naming so the headless service doesn't change.
   legacy: false
 
-# -- Ingresses, each input plugin will need it's own.
+# -- (list) Ingresses, each input plugin will need it's own.
+# @default -- See _values.yaml_
 ingresses: []
 #  - servicePort: 24224
 #    className: my-ingress-class
@@ -72,7 +73,7 @@ ingresses: []
 #          - chart-example.local
 #        secretName: chart-example-tls
 
-# -- Number of replicas to create if `autoscalling.enabled` is `false`.
+# -- Number of replicas to create if `autoscaling.enabled` is `false`.
 replicas: 1
 
 autoscaling:
@@ -84,7 +85,8 @@ autoscaling:
   maxReplicas: 3
   # -- Behaviour configuration for the `HorizontalPodAutoscaler`.
   behavior: {}
-  # -- Metrics configuration for the `HorizontalPodAutoscaler`.
+  # -- (list) Metrics configuration for the `HorizontalPodAutoscaler`.
+  # @default -- See _values.yaml_
   metrics: []
   #  - type: Resource
   #    resource:
@@ -102,7 +104,7 @@ ordinals: {}
 # -- Pod management policy for the `StatefulSet`.
 podManagementPolicy:
 
-# -- Min ready seconds for the `StatefulSet`.
+# -- (int) Min ready seconds for the `StatefulSet`.
 minReadySeconds:
 
 podDisruptionBudget:
@@ -127,10 +129,10 @@ podSecurityContext:
   seccompProfile:
     type: RuntimeDefault
 
-# -- Priority class name for the pod.
+# -- (string) Priority class name for the pod.
 priorityClassName:
 
-# -- Termination grace period for the pod in seconds.
+# -- (int) Termination grace period for the pod in seconds.
 terminationGracePeriodSeconds:
 
 # -- Security context for the default container.

charts/istio-operator/README.md

@@ -27,7 +27,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install istio-operator oci://ghcr.io/stevehipwell/helm-charts/istio-operator --version 2.13.1
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/
@@ -68,8 +68,8 @@ helm upgrade --install istio-operator stevehipwell/istio-operator --version 2.13
 | serviceMonitor.additionalLabels | object | `{}` | Additional labels for the `ServiceMonitor`. |
 | serviceMonitor.enabled | bool | `false` | If `true`, create a `ServiceMonitor` resource to support the _Prometheus Operator_. |
 | serviceMonitor.endpointConfig | object | `{}` | Additional endpoint configuration for the default `ServiceMonitor` endpoint. |
-| serviceMonitor.interval | string | `nil` | _Prometheus_ scrape interval (DEPRECATED). |
-| terminationGracePeriodSeconds | string | `nil` | Termination grace period for the pod in seconds. |
+| serviceMonitor.interval | int | `nil` | _Prometheus_ scrape interval (DEPRECATED). |
+| terminationGracePeriodSeconds | int | `nil` | Termination grace period for the pod in seconds. |
 | tolerations | list | `[]` | Node taints which will be tolerated for pod scheduling. |
 | topologySpreadConstraints | list | `[]` | Topology spread constraints for pod scheduling. If an explicit label selector is not provided one will be created from the pod selector labels. |
 | waitForResourcesTimeout | string | `"300s"` | Period to wait for resources before timing out. |

charts/istio-operator/README.md.gotmpl

@@ -21,7 +21,7 @@ To install the chart using the recommended OCI method you can use the following
 helm upgrade --install {{ template "chart.name" . }} oci://ghcr.io/stevehipwell/helm-charts/{{ template "chart.name" . }} --version {{ template "chart.version" . }}
 ```
 
-Alternativly you can use the legacy non-OCI method via the following commands.
+Alternatively you can use the legacy non-OCI method via the following commands.
 
 ```shell
 helm repo add stevehipwell https://stevehipwell.github.io/helm-charts/

charts/istio-operator/values.yaml

@@ -52,10 +52,10 @@ podSecurityContext:
   seccompProfile:
     type: RuntimeDefault
 
-# -- Priority class name for the pod.
+# -- (string) Priority class name for the pod.
 priorityClassName:
 
-# -- Termination grace period for the pod in seconds.
+# -- (int) Termination grace period for the pod in seconds.
 terminationGracePeriodSeconds:
 
 # -- Security context for the default container.
@@ -93,7 +93,7 @@ serviceMonitor:
   additionalLabels: {}
   # -- Additional endpoint configuration for the default `ServiceMonitor` endpoint.
   endpointConfig: {}
-  # -- _Prometheus_ scrape interval (DEPRECATED).
+  # -- (int) _Prometheus_ scrape interval (DEPRECATED).
   interval:
 
 dashboards: