Doc improvements to link to other charts and reference resource reque…

…sts and limits (#1131) * Doc improvements to link to other charts and reference resource requests and limits Signed-off-by: Pete Wall <[email protected]> * Fix yaml lint issues Signed-off-by: Pete Wall <[email protected]> --------- Signed-off-by: Pete Wall <[email protected]>
grafana · Jan 17, 2025 · b0ba416 · b0ba416
1 parent d85ce48
commit b0ba416
Show file tree

Hide file tree

Showing 12 changed files with 94 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -8,8 +8,9 @@
 ![GitHub Release](https://img.shields.io/github/v/release/grafana/k8s-monitoring-helm)
 ![GitHub Release Date](https://img.shields.io/github/release-date/grafana/k8s-monitoring-helm)
 
-[![Test Charts](https://github.com/grafana/k8s-monitoring-helm/workflows/Test/badge.svg?branch=main)](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/helm-test.yml?query=branch%3Amain)
-[![Release Charts](https://github.com/grafana/k8s-monitoring-helm/workflows/Release%20Helm%20chart/badge.svg?branch=main)](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/helm-release.yml?query=branch%3Amain)
+[![Unit Tests](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/unit-test.yml/badge.svg?branch=main)](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/unit-test.yml?query=branch%3Amain)
+[![Integration Tests](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/integration-test.yml/badge.svg?branch=main)](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/integration-test.yml?query=branch%3Amain)
+[![Platform Tests](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/platform-test.yml/badge.svg?branch=main)](https://github.com/grafana/k8s-monitoring-helm/actions/workflows/platform-test.yml?query=branch%3Amain)
 ![GitHub License](https://img.shields.io/github/license/grafana/k8s-monitoring-helm)
 
 </div>
@@ -23,34 +24,38 @@
 
 ## Usage
 
-[Helm](https://helm.sh/) must be installed to use the chart. Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
+[Helm](https://helm.sh/) must be installed to use the chart. Please refer to
+Helm's [documentation](https://helm.sh/docs/) to get started.
 
 Once Helm is set up properly, add the repository as follows:
 
 ```console
 helm repo add grafana https://grafana.github.io/helm-charts
 ```
 
-See the [Chart Documentation](https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/k8s-monitoring-v1/README.md) for chart install instructions.
+See
+the [Chart Documentation](https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/k8s-monitoring-v1/README.md)
+for chart install instructions.
 
 ## Office Hours
 
 We hold office hours roughly monthly. Meeting times and recordings will be posted here:
 
-| Date       | Topic                       | Link                                      |
-|------------|-----------------------------|-------------------------------------------|
-| 2024-10-11 | Upcoming 2.0 version        | [Recording](https://youtu.be/2N6MQN45Gy8) |
-| 2024-11-22 | 2.0 Status                  | [Recording](https://youtu.be/rR6yxTEGLZc) |
-| 2024-12-19 | 2.0 Status and release date | [Recording](https://youtu.be/zkhR_5v1i9g) |
+| Date       | Topic                       | Link                                                                           |
+|------------|-----------------------------|--------------------------------------------------------------------------------|
+| 2024-10-11 | Upcoming 2.0 version        | [Recording](https://youtu.be/2N6MQN45Gy8)                                      |
+| 2024-11-22 | 2.0 Status                  | [Recording](https://youtu.be/rR6yxTEGLZc)                                      |
+| 2024-12-19 | 2.0 Status and release date | [Recording](https://youtu.be/zkhR_5v1i9g)                                      |
+| 2024-01-24 | 2.0 Release and future      | [Meeting Link](https://grafana.slack.com/archives/CAGMZG3GB/p1737059655740439) |
 
 ## Contributing
 
 See our [Contributing Guide](./CONTRIBUTING.md) for more information.
 
 ## Links
 
--   [Kubernetes Monitoring on Grafana Cloud](https://grafana.com/docs/grafana-cloud/kubernetes-monitoring/)
--   [Grafana Alloy](https://github.com/grafana/alloy)
--   [Kube State Metrics](https://github.com/kubernetes/kube-state-metrics)
--   [Node Exporter](https://github.com/prometheus/node_exporter)
--   [OpenCost](https://github.com/opencost/opencost)
+- [Kubernetes Monitoring on Grafana Cloud](https://grafana.com/docs/grafana-cloud/kubernetes-monitoring/)
+- [Grafana Alloy](https://github.com/grafana/alloy)
+- [Kube State Metrics](https://github.com/kubernetes/kube-state-metrics)
+- [Node Exporter](https://github.com/prometheus/node_exporter)
+- [OpenCost](https://github.com/opencost/opencost)
diff --git a/charts/k8s-monitoring/README.md b/charts/k8s-monitoring/README.md
@@ -288,7 +288,7 @@ podLogs:
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| autoInstrumentation | object | Disabled | Auto-Instrumentation. Requires destinations that supports metrics, logs, and traces. To see the valid options, please see the [Application Observability feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-application-observability). |
+| autoInstrumentation | object | Disabled | Auto-Instrumentation. Requires destinations that supports metrics, logs, and traces. To see the valid options, please see the [Auto-Instrumentation feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-auto-instrumentation). |
 | autoInstrumentation.destinations | list | `[]` | The destinations where application data will be sent. If empty, all capable destinations will be used. |
 | autoInstrumentation.enabled | bool | `false` | Enable automatic instrumentation for applications. |
 

diff --git a/charts/k8s-monitoring/charts/feature-auto-instrumentation/values.yaml b/charts/k8s-monitoring/charts/feature-auto-instrumentation/values.yaml
@@ -1,3 +1,4 @@
+# yamllint disable rule:comments-indentation
 ---
 # -- Name override
 # @section -- General settings

diff --git a/charts/k8s-monitoring/docs/examples/platforms/openshift/README.md b/charts/k8s-monitoring/docs/examples/platforms/openshift/README.md
@@ -139,4 +139,5 @@ alloy-logs:
   global:
     podSecurityContext:
       seLinuxOptions:
-        type: spc_t```
+        type: spc_t
+```
diff --git a/charts/k8s-monitoring/docs/examples/platforms/openshift/values.yaml b/charts/k8s-monitoring/docs/examples/platforms/openshift/values.yaml
@@ -118,4 +118,4 @@ alloy-logs:
   global:
     podSecurityContext:
       seLinuxOptions:
-        type: spc_t
+        type: spc_t
diff --git a/charts/k8s-monitoring/tests/integration/auth/deployments/query-test.yaml b/charts/k8s-monitoring/tests/integration/auth/deployments/query-test.yaml
@@ -57,12 +57,12 @@ spec:
             type: logql
           - query: count_over_time({cluster="$CLUSTER", destination="loki-bearer-token", job!="integrations/kubernetes/eventhandler"}[1h])
             type: logql
-#          - query: count_over_time({cluster="$CLUSTER", destination="loki-otlp-noauth", job!="integrations/kubernetes/eventhandler"}[1h])
-#            type: logql
-#          - query: count_over_time({cluster="$CLUSTER", destination="loki-otlp-basicauth", job!="integrations/kubernetes/eventhandler"}[1h])
-#            type: logql
-#          - query: count_over_time({cluster="$CLUSTER", destination="loki-otlp-bearer-token", job!="integrations/kubernetes/eventhandler"}[1h])
-#            type: logql
+          # - query: count_over_time({cluster="$CLUSTER", destination="loki-otlp-noauth", job!="integrations/kubernetes/eventhandler"}[1h])
+          #   type: logql
+          # - query: count_over_time({cluster="$CLUSTER", destination="loki-otlp-basicauth", job!="integrations/kubernetes/eventhandler"}[1h])
+          #   type: logql
+          # - query: count_over_time({cluster="$CLUSTER", destination="loki-otlp-bearer-token", job!="integrations/kubernetes/eventhandler"}[1h])
+          #   type: logql
 
           # DPM check
           - query: avg(count_over_time(scrape_samples_scraped{cluster="$CLUSTER"}[1m]))

diff --git a/charts/k8s-monitoring/tests/platform/eks-with-windows/Makefile b/charts/k8s-monitoring/tests/platform/eks-with-windows/Makefile
@@ -11,6 +11,7 @@ deployments/test-variables.yaml:
 
 deployments/grafana-cloud-credentials.yaml:
 	echo "---" > $@
+	echo "# yamllint disable rule:line-length" >> $@
 	kubectl create secret generic grafana-cloud-credentials \
   		--from-literal=PROMETHEUS_USER="$$GRAFANA_CLOUD_METRICS_USERNAME" \
   		--from-literal=PROMETHEUS_PASS="$$GRAFANA_CLOUD_RW_POLICY_TOKEN" \

diff --git a/charts/k8s-monitoring/tests/platform/gke-autopilot/Makefile b/charts/k8s-monitoring/tests/platform/gke-autopilot/Makefile
@@ -11,6 +11,7 @@ deployments/test-variables.yaml:
 
 deployments/grafana-cloud-credentials.yaml:
 	echo "---" > $@
+	echo "# yamllint disable rule:line-length" >> $@
 	kubectl create secret generic grafana-cloud-credentials \
   		--from-literal=PROMETHEUS_USER="$$GRAFANA_CLOUD_METRICS_USERNAME" \
   		--from-literal=PROMETHEUS_PASS="$$GRAFANA_CLOUD_RW_POLICY_TOKEN" \

diff --git a/charts/k8s-monitoring/tests/platform/grafana-cloud-features/k8s-monitoring/Makefile b/charts/k8s-monitoring/tests/platform/grafana-cloud-features/k8s-monitoring/Makefile
@@ -11,6 +11,7 @@ deployments/test-variables.yaml:
 
 deployments/grafana-cloud-credentials.yaml:
 	echo "---" > $@
+	echo "# yamllint disable rule:line-length" >> $@
 	kubectl create secret generic grafana-cloud-credentials \
   		--from-literal=PROMETHEUS_USER="$$GRAFANA_CLOUD_METRICS_USERNAME" \
   		--from-literal=PROMETHEUS_PASS="$$GRAFANA_CLOUD_RW_POLICY_TOKEN" \

diff --git a/charts/k8s-monitoring/tests/platform/otlp-gateway/Makefile b/charts/k8s-monitoring/tests/platform/otlp-gateway/Makefile
@@ -11,6 +11,7 @@ deployments/test-variables.yaml:
 
 deployments/grafana-cloud-credentials.yaml:
 	echo "---" > $@
+	echo "# yamllint disable rule:line-length" >> $@
 	kubectl create secret generic grafana-cloud-credentials \
   		--from-literal=OTLP_GATEWAY_USER="$$GRAFANA_CLOUD_OTLP_USERNAME" \
   		--from-literal=OTLP_GATEWAY_PASS="$$GRAFANA_CLOUD_RW_POLICY_TOKEN" \

diff --git a/charts/k8s-monitoring/tests/platform/remote-config/Makefile b/charts/k8s-monitoring/tests/platform/remote-config/Makefile
@@ -11,6 +11,7 @@ deployments/test-variables.yaml:
 
 deployments/grafana-cloud-credentials.yaml:
 	echo "---" > $@
+	echo "# yamllint disable rule:line-length" >> $@
 	kubectl create secret generic grafana-cloud-credentials \
   		--from-literal=GRAFANA_CLOUD_FLEET_MGMT_USER="$$GRAFANA_CLOUD_FLEET_MGMT_USER" \
   		--from-literal=GRAFANA_CLOUD_FLEET_MGMT_TOKEN="$$GRAFANA_CLOUD_FLEET_MGMT_TOKEN" \

diff --git a/charts/k8s-monitoring/values.yaml b/charts/k8s-monitoring/values.yaml
@@ -1,3 +1,4 @@
+# yamllint disable rule:line-length rule:comments-indentation
 ---
 cluster:
   # -- The name for this cluster.
@@ -62,6 +63,8 @@ clusterMetrics:
   # @ignored
   collector: alloy-metrics
 
+  # To see additional options, please see the [Cluster Monitoring feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-cluster-metrics).
+
 # -- Cluster events.
 # Requires a destination that supports logs.
 # To see the valid options, please see the [Cluster Events feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-cluster-events).
@@ -81,6 +84,8 @@ clusterEvents:
   # @ignored
   collector: alloy-singleton
 
+  # To see additional options, please see the [Cluster Events feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-cluster-events).
+
 # -- Node logs.
 # Requires a destination that supports logs.
 # To see the valid options, please see the [Node Logs feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-node-logs).
@@ -95,8 +100,13 @@ nodeLogs:
   # @section -- Features - Node Logs
   destinations: []
 
+  # -- Which collector to assign this feature to. Do not change this unless you are sure of what you are doing.
+  # @section -- Features - Node Logs
+  # @ignored
   collector: alloy-logs
 
+  # To see additional options, please see the [Node Logs feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-node-logs).
+
 # -- Pod logs.
 # Requires a destination that supports logs.
 # To see the valid options, please see the [Pod Logs feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-pod-logs).
@@ -111,8 +121,13 @@ podLogs:
   # @section -- Features - Pod Logs
   destinations: []
 
+  # -- Which collector to assign this feature to. Do not change this unless you are sure of what you are doing.
+  # @section -- Features - Pod Logs
+  # @ignored
   collector: alloy-logs
 
+  # To see additional options, please see the [Pod Logs feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-pod-logs).
+
 # -- Application Observability.
 # Requires destinations that supports metrics, logs, and traces.
 # To see the valid options, please see the [Application Observability feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-application-observability).
@@ -132,9 +147,11 @@ applicationObservability:
   # @ignored
   collector: alloy-receiver
 
+  # To see additional options, please see the [Application Observability feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-application-observability).
+
 # -- Auto-Instrumentation.
 # Requires destinations that supports metrics, logs, and traces.
-# To see the valid options, please see the [Application Observability feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-application-observability).
+# To see the valid options, please see the [Auto-Instrumentation feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-auto-instrumentation).
 # @default -- Disabled
 # @section -- Features - Auto-Instrumentation
 autoInstrumentation:
@@ -151,6 +168,8 @@ autoInstrumentation:
   # @ignored
   collector: alloy-metrics
 
+  # To see additional options, please see the [Auto-Instrumentation feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-auto-instrumentation).
+
 # -- Annotation Autodiscovery enables gathering metrics from Kubernetes Pods and Services discovered by special annotations.
 # Requires a destination that supports metrics.
 # To see the valid options, please see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-annotation-autodiscovery).
@@ -170,10 +189,11 @@ annotationAutodiscovery:
   # @ignored
   collector: alloy-metrics
 
+  # To see additional options, please see the [Annotation Autodiscovery feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-annotation-autodiscovery).
+
 # -- Prometheus Operator Objects enables the gathering of metrics from objects like Probes, PodMonitors, and
 # ServiceMonitors. Requires a destination that supports metrics.
-# To see the valid options, please see the
-# [Prometheus Operator Objects feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-prometheus-operator-objects).
+# To see the valid options, please see the [Prometheus Operator Objects feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-prometheus-operator-objects).
 # @default -- Disabled
 # @section -- Features - Prometheus Operator Objects
 prometheusOperatorObjects:
@@ -190,6 +210,8 @@ prometheusOperatorObjects:
   # @ignored
   collector: alloy-metrics
 
+  # To see additional options, please see the [Prometheus Operator Objects feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-prometheus-operator-objects).
+
 # -- Profiling enables gathering profiles from applications.
 # Requires a destination that supports profiles.
 # To see the valid options, please see the [Profiling feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-profiling).
@@ -209,6 +231,8 @@ profiling:
   # @ignored
   collector: alloy-profiles
 
+  # To see additional options, please see the [Profiling feature documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-profiling).
+
 # -- Service Integrations enables gathering telemetry data for common services and applications deployed to Kubernetes.
 # To see the valid options, please see the [Service Integrations documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-integrations).
 # @default -- No integrations enabled
@@ -223,6 +247,8 @@ integrations:
   # @ignored
   collector: alloy-metrics
 
+  # To see additional options, please see the [Service Integrations documentation](https://github.com/grafana/k8s-monitoring-helm/tree/main/charts/k8s-monitoring/charts/feature-integrations).
+
 # -- Self-reporting creates a single metric and log that reports anonymized information about how this Helm chart was
 # configured. It reports features enabled, destinations types used, and alloy instances enabled. It does not report any
 # actual telemetry data, credentials or configuration, or send any data to any destination other than the ones
@@ -246,6 +272,7 @@ selfReporting:
 #
 
 # An Alloy instance for collecting metrics.
+# To see additional valid options, please see the [Alloy Helm chart documentation](https://github.com/grafana/alloy/tree/main/operations/helm/charts/alloy).
 alloy-metrics:
   # -- Deploy the Alloy instance for collecting metrics.
   # @section -- Collectors - Alloy Metrics
@@ -349,6 +376,11 @@ alloy-metrics:
       seccompProfile:
         type: "RuntimeDefault"
 
+    # Set resource requests and limits. [Guidelines](https://grafana.com/docs/alloy/latest/introduction/estimate-resource-usage/).
+    # resources:
+    #   requests: {}
+    #   limits: {}
+
   controller:
     # -- The type of controller to use for the Alloy Metrics instance.
     # @section -- Collectors - Alloy Metrics
@@ -371,6 +403,7 @@ alloy-metrics:
   crds: {create: false}
 
 # An Alloy instance for data sources required to be deployed on a single replica.
+# To see additional valid options, please see the [Alloy Helm chart documentation](https://github.com/grafana/alloy/tree/main/operations/helm/charts/alloy).
 alloy-singleton:
   # -- Deploy the Alloy instance for data sources required to be deployed on a single replica.
   # @section -- Collectors - Alloy Singleton
@@ -456,6 +489,11 @@ alloy-singleton:
       seccompProfile:
         type: "RuntimeDefault"
 
+    # Set resource requests and limits. [Guidelines](https://grafana.com/docs/alloy/latest/introduction/estimate-resource-usage/).
+    # resources:
+    #   requests: {}
+    #   limits: {}
+
   controller:
     # -- The type of controller to use for the Alloy Singleton instance.
     # @section -- Collectors - Alloy Singleton
@@ -478,6 +516,7 @@ alloy-singleton:
   crds: {create: false}
 
 # An Alloy instance for collecting log data.
+# To see additional valid options, please see the [Alloy Helm chart documentation](https://github.com/grafana/alloy/tree/main/operations/helm/charts/alloy).
 alloy-logs:
   # -- Deploy the Alloy instance for collecting log data.
   # @section -- Collectors - Alloy Logs
@@ -575,6 +614,11 @@ alloy-logs:
       seccompProfile:
         type: "RuntimeDefault"
 
+    # Set resource requests and limits. [Guidelines](https://grafana.com/docs/alloy/latest/introduction/estimate-resource-usage/).
+    # resources:
+    #   requests: {}
+    #   limits: {}
+
   controller:
     # -- The type of controller to use for the Alloy Logs instance.
     # @section -- Collectors - Alloy Logs
@@ -593,6 +637,7 @@ alloy-logs:
   crds: {create: false}
 
 # An Alloy instance for opening receivers to collect application data.
+# To see additional valid options, please see the [Alloy Helm chart documentation](https://github.com/grafana/alloy/tree/main/operations/helm/charts/alloy).
 alloy-receiver:
   # -- Deploy the Alloy instance for opening receivers to collect application data.
   # @section -- Collectors - Alloy Receiver
@@ -683,6 +728,11 @@ alloy-receiver:
       seccompProfile:
         type: "RuntimeDefault"
 
+    # Set resource requests and limits. [Guidelines](https://grafana.com/docs/alloy/latest/introduction/estimate-resource-usage/).
+    # resources:
+    #   requests: {}
+    #   limits: {}
+
   controller:
     # -- The type of controller to use for the Alloy Receiver instance.
     # @section -- Collectors - Alloy Receiver
@@ -701,6 +751,7 @@ alloy-receiver:
   crds: {create: false}
 
 # An Alloy instance for gathering profiles.
+# To see additional valid options, please see the [Alloy Helm chart documentation](https://github.com/grafana/alloy/tree/main/operations/helm/charts/alloy).
 alloy-profiles:
   # -- Deploy the Alloy instance for gathering profiles.
   # @section -- Collectors - Alloy Profiles
@@ -791,6 +842,11 @@ alloy-profiles:
       runAsGroup: 0
       runAsUser: 0
 
+    # Set resource requests and limits. [Guidelines](https://grafana.com/docs/alloy/latest/introduction/estimate-resource-usage/).
+    # resources:
+    #   requests: {}
+    #   limits: {}
+
   controller:
     # -- The type of controller to use for the Alloy Profiles instance.
     # @section -- Collectors - Alloy Profiles