Add: Kubernetes recommande labels #1387

nlamirault · 2021-02-20T18:53:45Z

Signed-off-by: Nicolas Lamirault nicolas.lamirault@gmail.com

What this PR does / why we need it:

Add Kubernetes recommanded labels https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/

Ex:

---
# Source: kube-state-metrics/templates/serviceaccount.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  labels:
    app: kube-state-metrics
    
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/version: "2.13.0"
    app.kubernetes.io/part-of: kube-state-metrics 
    helm.sh/chart: kube-state-metrics-2.13.0
  name: RELEASE-NAME-kube-state-metrics
  namespace: default
imagePullSecrets:
  []

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Output :

$ helm template charts/kube-state-metrics

---
# Source: kube-state-metrics/templates/serviceaccount.yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  labels:
    app: kube-state-metrics    
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/version: "2.13.0"
    app.kubernetes.io/part-of: kube-state-metrics 
    helm.sh/chart: kube-state-metrics-2.13.0
  name: RELEASE-NAME-kube-state-metrics
  namespace: default
imagePullSecrets:
  []
---
# Source: kube-state-metrics/templates/role.yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  labels:
    app: kube-state-metrics    
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/version: "2.13.0"
    app.kubernetes.io/part-of: kube-state-metrics 
    helm.sh/chart: kube-state-metrics-2.13.0
  name: RELEASE-NAME-kube-state-metrics
rules:

- apiGroups: ["certificates.k8s.io"]
  resources:
  - certificatesigningrequests
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - configmaps
  verbs: ["list", "watch"]

- apiGroups: ["batch"]
  resources:
  - cronjobs
  verbs: ["list", "watch"]

- apiGroups: ["extensions", "apps"]
  resources:
  - daemonsets
  verbs: ["list", "watch"]

- apiGroups: ["extensions", "apps"]
  resources:
  - deployments
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - endpoints
  verbs: ["list", "watch"]

- apiGroups: ["autoscaling"]
  resources:
  - horizontalpodautoscalers
  verbs: ["list", "watch"]

- apiGroups: ["extensions", "networking.k8s.io"]
  resources:
  - ingresses
  verbs: ["list", "watch"]

- apiGroups: ["batch"]
  resources:
  - jobs
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - limitranges
  verbs: ["list", "watch"]

- apiGroups: ["admissionregistration.k8s.io"]
  resources:
    - mutatingwebhookconfigurations
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - namespaces
  verbs: ["list", "watch"]

- apiGroups: ["networking.k8s.io"]
  resources:
  - networkpolicies
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - nodes
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - persistentvolumeclaims
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - persistentvolumes
  verbs: ["list", "watch"]

- apiGroups: ["policy"]
  resources:
    - poddisruptionbudgets
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - pods
  verbs: ["list", "watch"]

- apiGroups: ["extensions", "apps"]
  resources:
  - replicasets
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - replicationcontrollers
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - resourcequotas
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - secrets
  verbs: ["list", "watch"]

- apiGroups: [""]
  resources:
  - services
  verbs: ["list", "watch"]

- apiGroups: ["apps"]
  resources:
  - statefulsets
  verbs: ["list", "watch"]

- apiGroups: ["storage.k8s.io"]
  resources:
    - storageclasses
  verbs: ["list", "watch"]

- apiGroups: ["admissionregistration.k8s.io"]
  resources:
    - validatingwebhookconfigurations
  verbs: ["list", "watch"]

- apiGroups: ["storage.k8s.io"]
  resources:
    - volumeattachments
  verbs: ["list", "watch"]
---
# Source: kube-state-metrics/templates/clusterrolebinding.yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  labels:
    app: kube-state-metrics    
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/version: "2.13.0"
    app.kubernetes.io/part-of: kube-state-metrics 
    helm.sh/chart: kube-state-metrics-2.13.0
  name: RELEASE-NAME-kube-state-metrics
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: RELEASE-NAME-kube-state-metrics
subjects:
- kind: ServiceAccount
  name: RELEASE-NAME-kube-state-metrics
  namespace: default
---
# Source: kube-state-metrics/templates/service.yaml
apiVersion: v1
kind: Service
metadata:
  name: RELEASE-NAME-kube-state-metrics
  namespace: default
  labels:
    app: kube-state-metrics    
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/version: "2.13.0"
    app.kubernetes.io/part-of: kube-state-metrics 
    helm.sh/chart: kube-state-metrics-2.13.0
  annotations:
    prometheus.io/scrape: 'true'
spec:
  type: "ClusterIP"
  ports:
  - name: "http"
    protocol: TCP
    port: 8080
    targetPort: 8080
  
  selector:
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
---
# Source: kube-state-metrics/templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: RELEASE-NAME-kube-state-metrics
  namespace: default
  labels:
    app: kube-state-metrics    
    app.kubernetes.io/name: kube-state-metrics
    app.kubernetes.io/instance: RELEASE-NAME
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/version: "2.13.0"
    app.kubernetes.io/part-of: kube-state-metrics 
    helm.sh/chart: kube-state-metrics-2.13.0
spec:
  selector:
    matchLabels:
      app.kubernetes.io/name: kube-state-metrics
  replicas: 1
  template:
    metadata:
      labels:
        app: kube-state-metrics        
        app.kubernetes.io/name: kube-state-metrics
        app.kubernetes.io/instance: RELEASE-NAME
        app.kubernetes.io/managed-by: Helm
        app.kubernetes.io/version: "2.13.0"
        app.kubernetes.io/part-of: kube-state-metrics 
        helm.sh/chart: kube-state-metrics-2.13.0
    spec:
      hostNetwork: false
      serviceAccountName: RELEASE-NAME-kube-state-metrics
      securityContext:
        fsGroup: 65534
        runAsGroup: 65534
        runAsUser: 65534
      containers:
      - name: kube-state-metrics
        args:


        - --collectors=certificatesigningrequests


        - --collectors=configmaps


        - --collectors=cronjobs


        - --collectors=daemonsets


        - --collectors=deployments


        - --collectors=endpoints


        - --collectors=horizontalpodautoscalers


        - --collectors=ingresses


        - --collectors=jobs


        - --collectors=limitranges


        - --collectors=mutatingwebhookconfigurations


        - --collectors=namespaces


        - --collectors=networkpolicies


        - --collectors=nodes


        - --collectors=persistentvolumeclaims


        - --collectors=persistentvolumes


        - --collectors=poddisruptionbudgets


        - --collectors=pods


        - --collectors=replicasets


        - --collectors=replicationcontrollers


        - --collectors=resourcequotas


        - --collectors=secrets


        - --collectors=services


        - --collectors=statefulsets


        - --collectors=storageclasses


        - --collectors=validatingwebhookconfigurations



        - --collectors=volumeattachments





        - --telemetry-port=8081
        imagePullPolicy: IfNotPresent
        image: "quay.io/coreos/kube-state-metrics:v1.9.7"
        ports:
        - containerPort: 8080
        livenessProbe:
          httpGet:
            path: /healthz
            port: 8080
          initialDelaySeconds: 5
          timeoutSeconds: 5
        readinessProbe:
          httpGet:
            path: /
            port: 8080
          initialDelaySeconds: 5
          timeoutSeconds: 5

Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

k8s-ci-robot · 2021-02-20T18:53:56Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nlamirault
To complete the pull request process, please assign mrueg after the PR has been reviewed.
You can assign the PR to them by writing /assign @mrueg in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

charts/kube-state-metrics/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mrueg · 2021-02-22T09:04:02Z

Thanks for your contribution!
To make sure I understood the PR correctly, you don't add the labels and want to move them into a template macro?

charts/kube-state-metrics/templates/_helpers.tpl

Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

tariq1890 · 2021-03-10T07:13:18Z

charts/kube-state-metrics/templates/clusterrolebinding.yaml

-    helm.sh/chart: {{ .Chart.Name }}-{{ .Chart.Version }}
-    app.kubernetes.io/managed-by: {{ .Release.Service }}
-    app.kubernetes.io/instance: {{ .Release.Name }}
+    app: {{ template "kube-state-metrics.name" . }}


Adding this lone app: label (not as part of templates) seems inconsistent to me. Why not add this app: label through .Values.customLabels?

I do that to be consistent with other charts (Like : https://github.com/prometheus-community/helm-charts/blob/main/charts/kube-prometheus-stack/templates/prometheus/clusterrolebinding.yaml#L7).
Do you want i remove it and use customLabels ?

* master: (50 commits) RELEASE.md: Add missing bits to the release workflow update RBAC manifests to v1 Regenerate cli docs Cut 2.0.0-rc.1 Rename cli flag from label-metrics-allow-list to metric-labels-allowlist Fix docs README link to a nonexistent section cli-arguments.md: Fix docs go.mod: Update dependencies Makefile: Use promtool 2.25.2 Make/Dockerfile: Switch to 1.16 OWNERS: Add mrueg as reviewer examples: regenerate jsonnet/kube-state-metrics/kube-state-metrics.libsonnet: Remove old API internal/store/verticalpodautoscaler_test.go: Switch test to new API Update latest 1.9 version to 1.9.8 in README.md [Backport] Remove vendor directory cli-arguments.md: Fix docs go.mod: Update dependencies Make/Dockerfile: Switch to 1.16 Combine 4-into-1 ... Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

k8s-ci-robot · 2021-04-07T22:24:35Z

@nlamirault: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

mrueg · 2021-04-12T10:06:35Z

/hold
Thanks for a contribution!
We are currently migrating the chart to a new location. Please feel free to create a new PR in https://github.com/prometheus-community/helm-charts/ once the migration has been completed.

#1448

mrueg · 2021-04-27T16:25:07Z

Thanks for your contribution. We moved our helm charts to https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-state-metrics Feel free to reopen a PR on https://github.com/prometheus-community/helm-charts/ !

nlamirault added 2 commits February 20, 2021 19:51

Add: Kubernetes recommande labels

989a485

Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

Update: bump Chart version

5db1142

Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 20, 2021

k8s-ci-robot requested review from lilic and mrueg February 20, 2021 18:53

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 20, 2021

mrueg reviewed Feb 22, 2021

View reviewed changes

charts/kube-state-metrics/templates/_helpers.tpl Show resolved Hide resolved

brancz added the helm label Feb 22, 2021

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 23, 2021

nlamirault added 3 commits March 4, 2021 14:48

Update: missing resources

afe4589

Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

Merge branch 'master' into feat/k8s-labels

1d87e0c

Update: bump Chart version

eee494e

Signed-off-by: Nicolas Lamirault <nicolas.lamirault@gmail.com>

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 5, 2021

tariq1890 reviewed Mar 10, 2021

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 6, 2021

k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Apr 6, 2021

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 12, 2021

mrueg closed this Apr 27, 2021

nlamirault mentioned this pull request May 3, 2021

[kube-state-metrics] Add: Kubernetes recommanded labels and custom labels prometheus-community/helm-charts#927

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add: Kubernetes recommande labels #1387

Add: Kubernetes recommande labels #1387

nlamirault commented Feb 20, 2021 •

edited

Loading

k8s-ci-robot commented Feb 20, 2021

mrueg commented Feb 22, 2021

tariq1890 Mar 10, 2021

nlamirault Apr 6, 2021

k8s-ci-robot commented Apr 7, 2021

mrueg commented Apr 12, 2021

mrueg commented Apr 27, 2021

Add: Kubernetes recommande labels #1387

Add: Kubernetes recommande labels #1387

Conversation

nlamirault commented Feb 20, 2021 • edited Loading

k8s-ci-robot commented Feb 20, 2021

mrueg commented Feb 22, 2021

tariq1890 Mar 10, 2021

Choose a reason for hiding this comment

nlamirault Apr 6, 2021

Choose a reason for hiding this comment

k8s-ci-robot commented Apr 7, 2021

mrueg commented Apr 12, 2021

mrueg commented Apr 27, 2021

nlamirault commented Feb 20, 2021 •

edited

Loading