Apply suggestions from code review

1. kubeStateMetric to kubeStateMetrics
2. Added a few explanatory comments

Co-authored-by: Bhavin Gandhi <[email protected]>

Author: baba230896

stable/yugaware/templates/_helpers.tpl

@@ -116,7 +116,7 @@ Make list of allowed CORS origins
 {{/*
 kube-state-metrics
 */}}
-{{- define "kubeStateMetric.endpoint" -}}
+{{- define "yugaware.kubeStateMetrics.endpoint" -}}
 {{- if .Values.kubeStateMetric.customEndpoint -}}
 {{- .Values.kubeStateMetric.customEndpoint -}}
 {{- else if .Values.kubeStateMetric.install -}}

stable/yugaware/templates/configs.yaml

@@ -347,6 +347,8 @@ data:
             regex: "(.*)"
             target_label: "container_name"
             replacement: "$1"
+          # rename old name of the CPU metric to the new name and label
+          # ref: https://github.com/kubernetes/kube-state-metrics/blob/master/CHANGELOG.md#v200-alpha--2020-09-16
           - source_labels: ["__name__"]
             regex: "kube_pod_container_resource_requests_cpu_cores"
             target_label: "unit"

stable/yugaware/templates/kube-state-metrics-clusterrole.yaml

@@ -1,3 +1,4 @@
+# Adapted from https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-state-metrics (Apache-2.0 license)
 {{- if and .Values.kubeStateMetric.install (not .Values.kubeStateMetric.customEndpoint) -}}
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole

stable/yugaware/templates/kube-state-metrics-deployment.yaml

@@ -1,3 +1,4 @@
+# Adapted from https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-state-metrics (Apache-2.0 license)
 {{- if and .Values.kubeStateMetric.install (not .Values.kubeStateMetric.customEndpoint) -}}
 apiVersion: apps/v1
 kind: Deployment

stable/yugaware/values.yaml

@@ -178,7 +178,7 @@ additionalAppConf:
 # pdbPolicyVersionOverride: "v1beta1"
 
 ## kube-state-metric support
-## Custom endpoint has higher priority than installation. 
+## Custom endpoint has higher priority than installation. The endpoint value defaults to kube-state-metrics.kube-system.svc.<domainName>:8080.
 kubeStateMetric:
   ## To provide custom kube-state-metric endpoint
   # customEndpoint: "kube-state-metrics.svc.cluster.local:8080"
@@ -205,7 +205,7 @@ kubeStateMetric:
   ## for example: --enable-gzip-encoding, --log-file, etc.
   ## all the possible args can be found here: https://github.com/kubernetes/kube-state-metrics/blob/master/docs/cli-arguments.md
   extraArgs: []
-  ## As we know platform need only nodes and pods metrics from kube-state-metrics
-  ## So we just enable the collector for nodes and pods.
+  ## As we know platform need only pods metrics from kube-state-metrics
+  ## So we just enable the collector for pods.
   collectors:
     - pods