Massive docs and tests update

Signed-off-by: Pete Wall <pete.wall@grafana.com>
grafana · Oct 4, 2024 · 2698986 · 2698986
1 parent 93786b4
commit 2698986
Show file tree

Hide file tree

Showing 56 changed files with 459 additions and 88 deletions.
diff --git a/Makefile b/Makefile
@@ -13,6 +13,7 @@ build:
 
 .PHONY: test
 test: build
+	helm repo update
 	set -e && \
 	for chart in $(FEATURE_CHARTS); do \
 		make -C charts/$$chart test; \

diff --git a/charts/feature-annotation-autodiscovery/Chart.yaml b/charts/feature-annotation-autodiscovery/Chart.yaml
@@ -3,6 +3,8 @@ apiVersion: v2
 name: k8s-monitoring-feature-annotation-autodiscovery
 description: Gathers metrics automatically based on Kubernetes Pod and Service annotations
 icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg
+sources:
+  - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery
 version: 1.0.0
 appVersion: 1.0.0
 maintainers:

diff --git a/charts/feature-annotation-autodiscovery/Makefile b/charts/feature-annotation-autodiscovery/Makefile
@@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json
 .PHONY: test
 test: build
 	helm lint .
-	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts .
+	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts .
 ifdef HAS_HELM_UNITTEST
 	helm unittest .
 else

diff --git a/charts/feature-annotation-autodiscovery/README.md b/charts/feature-annotation-autodiscovery/README.md
@@ -1,14 +1,38 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
 # k8s-monitoring-feature-annotation-autodiscovery
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
-
 Gathers metrics automatically based on Kubernetes Pod and Service annotations
 
+The annotation-based autodiscovery feature makes it very simple to add scrape targets. With this feature enabled, any
+Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered
+and scraped by the collector. There are several other annotations that can be used to customize the behavior of the
+scrape configuration, such as:
+
+*   `k8s.grafana.com/job`: The value to use for the `job` label.
+*   `k8s.grafana.com/instance`: The value to use for the `instance` label.
+*   `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`.
+*   `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports.
+*   `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports.
+*   `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`.
+*   `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`.
+
 ## Maintainers
 
 | Name | Email | Url |
 | ---- | ------ | --- |
 | petewall | <pete.wall@grafana.com> |  |
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+## Source Code
+
+* <https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-annotation-autodiscovery>
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
 
 ## Values
 
@@ -60,6 +84,3 @@ Gathers metrics automatically based on Kubernetes Pod and Service annotations
 |-----|------|---------|-------------|
 | global.maxCacheSize | int | `100000` | Sets the max_cache_size for every prometheus.relabel component. ([docs](https://grafana.com/docs/alloy/latest/reference/components/prometheus.relabel/#arguments)) This should be at least 2x-5x your largest scrape target or samples appended rate. |
 | global.scrapeInterval | string | `"60s"` | How frequently to scrape metrics. |
-
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/feature-annotation-autodiscovery/README.md.gotmpl b/charts/feature-annotation-autodiscovery/README.md.gotmpl
@@ -0,0 +1,32 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+{{ template "chart.badgesSection" . }}
+{{ template "chart.description" . }}
+{{ template "chart.homepageLine" . }}
+
+The annotation-based autodiscovery feature makes it very simple to add scrape targets. With this feature enabled, any
+Kubernetes Pods or Services with the `k8s.grafana.com/scrape` annotation set to `true` will be automatically discovered
+and scraped by the collector. There are several other annotations that can be used to customize the behavior of the
+scrape configuration, such as:
+
+*   `k8s.grafana.com/job`: The value to use for the `job` label.
+*   `k8s.grafana.com/instance`: The value to use for the `instance` label.
+*   `k8s.grafana.com/metrics.path`: The path to scrape for metrics. Defaults to `/metrics`.
+*   `k8s.grafana.com/metrics.portNumber`: The port on the Pod or Service to scrape for metrics. This is used to target a specific port by its number, rather than all ports.
+*   `k8s.grafana.com/metrics.portName`: The named port on the Pod or Service to scrape for metrics. This is used to target a specific port by its name, rather than all ports.
+*   `k8s.grafana.com/metrics.scheme`: The scheme to use when scraping metrics. Defaults to `http`.
+*   `k8s.grafana.com/metrics.scrapeInterval`: The scrape interval to use when scraping metrics. Defaults to `60s`.
+
+{{ template "chart.maintainersSection" . }}
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+{{ template "chart.sourcesSection" . }}
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
+{{ template "chart.requirementsSection" . }}
+{{ template "chart.valuesSection" . }}
diff --git a/charts/feature-application-observability/Chart.yaml b/charts/feature-application-observability/Chart.yaml
@@ -3,6 +3,8 @@ apiVersion: v2
 name: k8s-monitoring-feature-application-observability
 description: Gathers application data
 icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg
+sources:
+  - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability
 version: 1.0.0
 appVersion: 1.0.0
 maintainers:

diff --git a/charts/feature-application-observability/Makefile b/charts/feature-application-observability/Makefile
@@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json
 .PHONY: test
 test: build
 	helm lint .
-	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts .
+	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts .
 ifdef HAS_HELM_UNITTEST
 	helm unittest .
 else

diff --git a/charts/feature-application-observability/README.md b/charts/feature-application-observability/README.md
@@ -1,14 +1,28 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
 # k8s-monitoring-feature-application-observability
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
-
 Gathers application data
 
+The Application Observability feature enables the collection of application telemetry data. Enabling this feature
+requires enabling one or more receivers where data will be sent from the application.
+
 ## Maintainers
 
 | Name | Email | Url |
 | ---- | ------ | --- |
 | petewall | <pete.wall@grafana.com> |  |
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+## Source Code
+
+* <https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-application-observability>
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
 
 ## Values
 
@@ -74,6 +88,3 @@ Gathers application data
 | traces.enabled | bool | `true` |  |
 | traces.filters | object | `{"span":[],"spanevent":[]}` | Apply a filter to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.filter/)) |
 | traces.transforms | object | `{"resource":[],"span":[],"spanevent":[]}` | Apply a transformation to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.transform/)) |
-
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/feature-application-observability/README.md.gotmpl b/charts/feature-application-observability/README.md.gotmpl
@@ -0,0 +1,22 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+{{ template "chart.badgesSection" . }}
+{{ template "chart.description" . }}
+{{ template "chart.homepageLine" . }}
+
+The Application Observability feature enables the collection of application telemetry data. Enabling this feature
+requires enabling one or more receivers where data will be sent from the application.
+
+{{ template "chart.maintainersSection" . }}
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+{{ template "chart.sourcesSection" . }}
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
+{{ template "chart.requirementsSection" . }}
+{{ template "chart.valuesSection" . }}
diff --git a/charts/feature-cluster-events/Chart.yaml b/charts/feature-cluster-events/Chart.yaml
@@ -3,6 +3,8 @@ apiVersion: v2
 name: k8s-monitoring-feature-cluster-events
 description: Gathers Kubernetes Events
 icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg
+sources:
+  - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-events
 version: 1.0.0
 appVersion: 1.0.0
 maintainers:

diff --git a/charts/feature-cluster-events/Makefile b/charts/feature-cluster-events/Makefile
@@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json
 .PHONY: test
 test: build
 	helm lint .
-	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts .
+	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts .
 ifdef HAS_HELM_UNITTEST
 	helm unittest .
 else

diff --git a/charts/feature-cluster-events/README.md b/charts/feature-cluster-events/README.md
@@ -1,14 +1,28 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
 # k8s-monitoring-feature-cluster-events
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
-
 Gathers Kubernetes Events
 
+The Cluster Events feature enables the collection of Kubernetes events from the cluster. Events are captured as logs and
+are annotated with additional metadata to make them easier to search and filter.
+
 ## Maintainers
 
 | Name | Email | Url |
 | ---- | ------ | --- |
 | petewall | <pete.wall@grafana.com> |  |
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+## Source Code
+
+* <https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-events>
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
 
 ## Values
 
@@ -31,6 +45,3 @@ Gathers Kubernetes Events
 |-----|------|---------|-------------|
 | logFormat | string | `"logfmt"` | Log format used to forward cluster events. Allowed values: `logfmt` (default), `json`. |
 | namespaces | list | `[]` | List of namespaces to watch for events (`[]` means all namespaces) |
-
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/feature-cluster-events/README.md.gotmpl b/charts/feature-cluster-events/README.md.gotmpl
@@ -0,0 +1,22 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+{{ template "chart.badgesSection" . }}
+{{ template "chart.description" . }}
+{{ template "chart.homepageLine" . }}
+
+The Cluster Events feature enables the collection of Kubernetes events from the cluster. Events are captured as logs and
+are annotated with additional metadata to make them easier to search and filter.
+
+{{ template "chart.maintainersSection" . }}
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+{{ template "chart.sourcesSection" . }}
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
+{{ template "chart.requirementsSection" . }}
+{{ template "chart.valuesSection" . }}
diff --git a/charts/feature-cluster-metrics/Chart.yaml b/charts/feature-cluster-metrics/Chart.yaml
@@ -3,6 +3,8 @@ apiVersion: v2
 name: k8s-monitoring-feature-cluster-metrics
 description: Gathers Kubernetes Cluster metrics
 icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg
+sources:
+  - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-metrics
 version: 1.0.0
 appVersion: 1.0.0
 maintainers:

diff --git a/charts/feature-cluster-metrics/Makefile b/charts/feature-cluster-metrics/Makefile
@@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json
 .PHONY: test
 test: build
 	helm lint .
-	ct lint --config .ct.yaml --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts .
+	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts .
 ifdef HAS_HELM_UNITTEST
 	helm unittest .
 else

diff --git a/charts/feature-cluster-metrics/README.md b/charts/feature-cluster-metrics/README.md
@@ -132,6 +132,12 @@ action on the metric list, including filtering based on label or other actions.
 | petewall | <pete.wall@grafana.com> |  |
 
 <!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+## Source Code
+
+* <https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-cluster-metrics>
+<!-- markdownlint-enable list-marker-space -->
+
 ## Requirements
 
 | Repository | Name | Version |

diff --git a/charts/feature-cluster-metrics/README.md.gotmpl b/charts/feature-cluster-metrics/README.md.gotmpl
@@ -130,9 +130,11 @@ action on the metric list, including filtering based on label or other actions.
 
 {{ template "chart.maintainersSection" . }}
 
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
 {{ template "chart.sourcesSection" . }}
+<!-- markdownlint-enable list-marker-space -->
 
-<!-- markdownlint-disable no-bare-urls -->
 {{ template "chart.requirementsSection" . }}
 <!-- markdownlint-enable no-bare-urls -->
 

diff --git a/charts/feature-frontend-observability/Chart.yaml b/charts/feature-frontend-observability/Chart.yaml
@@ -3,6 +3,8 @@ apiVersion: v2
 name: k8s-monitoring-feature-frontend-observability
 description: Gathers frontend data
 icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg
+sources:
+  - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-frontend-observability
 version: 1.0.0
 appVersion: 1.0.0
 maintainers:

diff --git a/charts/feature-frontend-observability/Makefile b/charts/feature-frontend-observability/Makefile
@@ -26,7 +26,7 @@ build: README.md Chart.lock values.schema.json
 .PHONY: test
 test: build
 	helm lint .
-	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --charts .
+	ct lint --lint-conf ../../.configs/lintconf.yaml --check-version-increment=false --helm-dependency-extra-args=--skip-refresh --charts .
 ifdef HAS_HELM_UNITTEST
 	helm unittest .
 else

diff --git a/charts/feature-frontend-observability/README.md b/charts/feature-frontend-observability/README.md
@@ -1,14 +1,28 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
 # k8s-monitoring-feature-frontend-observability
 
 ![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square)
-
 Gathers frontend data
 
+The Frontend Observability feature enables the collection of telemetry data from Frontend Applications, instrumented by
+[Grafana Faro](https://github.com/grafana/faro-web-sdk).
+
 ## Maintainers
 
 | Name | Email | Url |
 | ---- | ------ | --- |
 | petewall | <pete.wall@grafana.com> |  |
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+## Source Code
+
+* <https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-frontend-observability>
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
 
 ## Values
 
@@ -19,6 +33,3 @@ Gathers frontend data
 | fullnameOverride | string | `""` | Full name override |
 | nameOverride | string | `""` | Name override |
 | port | int | `12347` | Port to listen for HTTP traffic on. |
-
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
diff --git a/charts/feature-frontend-observability/README.md.gotmpl b/charts/feature-frontend-observability/README.md.gotmpl
@@ -0,0 +1,22 @@
+<!--
+(NOTE: Do not edit README.md directly. It is a generated file!)
+(      To make changes, please modify README.md.gotmpl and run `helm-docs`)
+-->
+
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+{{ template "chart.badgesSection" . }}
+{{ template "chart.description" . }}
+{{ template "chart.homepageLine" . }}
+
+The Frontend Observability feature enables the collection of telemetry data from Frontend Applications, instrumented by
+[Grafana Faro](https://github.com/grafana/faro-web-sdk).
+
+{{ template "chart.maintainersSection" . }}
+<!-- markdownlint-disable no-bare-urls -->
+<!-- markdownlint-disable list-marker-space -->
+{{ template "chart.sourcesSection" . }}
+<!-- markdownlint-enable list-marker-space -->
+<!-- markdownlint-enable no-bare-urls -->
+{{ template "chart.requirementsSection" . }}
+{{ template "chart.valuesSection" . }}
diff --git a/charts/feature-integrations/Chart.yaml b/charts/feature-integrations/Chart.yaml
@@ -3,6 +3,8 @@ apiVersion: v2
 name: k8s-monitoring-feature-integrations
 description: Service integrations
 icon: https://raw.githubusercontent.com/grafana/grafana/main/public/img/grafana_icon.svg
+sources:
+  - https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/feature-integrations
 version: 1.0.0
 appVersion: 1.0.0
 maintainers: