Kube State Metrics

Collect real-time information about cluster resources using Kube State Metrics

Configuration¶

Deploy Kube-state-metrics¶

Install Helm (this is the online installation mode)

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

Install kube-prometheus

The kube-prometheus installation package uses the Bitnami Helm chart solution, Bitnami Official Address

Get the latest version of the Chart package from the community:

helm pull oci://registry-1.docker.io/bitnamicharts/kube-prometheus

Get the verified offline version:

docker.io/bitnami/kube-state-metrics:2.13.0-debian-12-r6

Run the following command to extract the file:

tar xf kube-prometheus-9.6.3.tgz

Values file configuration instructions:

global:
  # Change to the private repository project address 
  imageRegistry: ""
  ## E.g.
  ## imagePullSecrets:
  ##   - myRegistryKeySecretName
  ##
  # This should be changed to the name of the secret for the private repository key
  imagePullSecrets: []

  # Here df-nfs-storage should be modified to a storageClass available within the cluster
  defaultstorageClass: "df-nfs-storage"
  # Here df-nfs-storage should be modified to a storageClass available within the cluster
  storageClass: "df-nfs-storage"
  ## Compatibility adaptations for Kubernetes platforms
  ##
  compatibility:
    ## Compatibility adaptations for Openshift
    ##
    openshift:
      ## @param global.compatibility.openshift.adaptSecurityContext Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation)
      ##
      adaptSecurityContext: auto
## @section Common parameters
....

Note: The namespace used for deployment must match the namespace configured in the datakit collector.

Run the following command to deploy:

cd kube-prometheus

helm upgrade -i -n datakit --create-namespace  datakit .

After deployment is complete, check whether it was successful using the following command:

kubectl get pod -n datakit

Configure Datakit¶

Add kubernetesprometheus.conf to the ConfigMap resource in datakit.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: datakit-conf
  namespace: datakit
data:
    kubernetesprometheus.conf: |-
      [inputs.kubernetesprometheus]

        [[inputs.kubernetesprometheus.instances]]
          role       = "service"
          namespaces = ["datakit"]
          selector   = "app.kubernetes.io/name=kube-state-metrics"

          scrape     = "true"
          scheme     = "http"
          port       = "__kubernetes_service_port_http_port"
          path       = "/metrics"
          params     = ""
          interval   = "15s"

          [inputs.kubernetesprometheus.instances.custom]
            measurement        = "kube-state-metrics"
            job_as_measurement = true
            [inputs.kubernetesprometheus.instances.custom.tags]
              cluster_name_k8s       = "promethues-cluster"
              job           = "kube-state-metrics"
              svc_name      = "__kubernetes_service_name"
              pod_name      = "__kubernetes_service_target_name"
              pod_namespace = "__kubernetes_service_target_namespace"
          [inputs.kubernetesprometheus.instances.auth]
            bearer_token_file      = "/var/run/secrets/kubernetes.io/serviceaccount/token"
            [inputs.kubernetesprometheus.instances.auth.tls_config]
              insecure_skip_verify = true
              cert     = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"

Mount kubernetesprometheus.conf Add the following under volumeMounts in the datakit.yaml file:

- mountPath: /usr/local/datakit/conf.d/kubernetesprometheus/kubernetesprometheus.conf
  name: datakit-conf
  subPath: kubernetesprometheus.conf
  readOnly: true

Run the following commands to restart datakit

kubectl delete -f datakit.yaml
kubectl apply -f datakit.yaml

Metrics¶