Skip to content

Commit ef8f1bf

Browse files
committed
docs: add OpenSSF Scorecard to README
Signed-off-by: Dale Henries <[email protected]>
1 parent fd3cd41 commit ef8f1bf

File tree

1 file changed

+35
-32
lines changed

1 file changed

+35
-32
lines changed

README.md

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes/kube-state-metrics)](https://goreportcard.com/report/github.com/kubernetes/kube-state-metrics)
55
[![Go Reference](https://pkg.go.dev/badge/github.com/kubernetes/kube-state-metrics.svg)](https://pkg.go.dev/github.com/kubernetes/kube-state-metrics)
66
[![govulncheck](https://github.com/kubernetes/kube-state-metrics/actions/workflows/govulncheck.yml/badge.svg)](https://github.com/kubernetes/kube-state-metrics/actions/workflows/govulncheck.yml)
7+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/kubernetes/kube-state-metrics/badge)](https://api.securityscorecards.dev/projects/github.com/kubernetes/kube-state-metrics)
78

89
kube-state-metrics (KSM) is a simple service that listens to the Kubernetes API
910
server and generates metrics about the state of the objects. (See examples in
@@ -30,31 +31,33 @@ are deleted they are no longer visible on the `/metrics` endpoint.
3031

3132
## Table of Contents
3233

33-
* [Versioning](#versioning)
34-
* [Kubernetes Version](#kubernetes-version)
35-
* [Compatibility matrix](#compatibility-matrix)
36-
* [Resource group version compatibility](#resource-group-version-compatibility)
37-
* [Container Image](#container-image)
38-
* [Metrics Documentation](#metrics-documentation)
39-
* [Conflict resolution in label names](#conflict-resolution-in-label-names)
40-
* [Kube-state-metrics self metrics](#kube-state-metrics-self-metrics)
41-
* [Resource recommendation](#resource-recommendation)
42-
* [Latency](#latency)
43-
* [A note on costing](#a-note-on-costing)
44-
* [kube-state-metrics vs. metrics-server](#kube-state-metrics-vs-metrics-server)
45-
* [Scaling kube-state-metrics](#scaling-kube-state-metrics)
46-
* [Resource recommendation](#resource-recommendation)
47-
* [Horizontal sharding](#horizontal-sharding)
48-
* [Automated sharding](#automated-sharding)
49-
* [Daemonset sharding for pod metrics](#daemonset-sharding-for-pod-metrics)
50-
* [Setup](#setup)
51-
* [Building the Docker container](#building-the-docker-container)
52-
* [Usage](#usage)
53-
* [Kubernetes Deployment](#kubernetes-deployment)
54-
* [Limited privileges environment](#limited-privileges-environment)
55-
* [Helm Chart](#helm-chart)
56-
* [Development](#development)
57-
* [Developer Contributions](#developer-contributions)
34+
- [Overview](#overview)
35+
- [Table of Contents](#table-of-contents)
36+
- [Versioning](#versioning)
37+
- [Kubernetes Version](#kubernetes-version)
38+
- [Compatibility matrix](#compatibility-matrix)
39+
- [Resource group version compatibility](#resource-group-version-compatibility)
40+
- [Container Image](#container-image)
41+
- [Metrics Documentation](#metrics-documentation)
42+
- [Conflict resolution in label names](#conflict-resolution-in-label-names)
43+
- [Kube-state-metrics self metrics](#kube-state-metrics-self-metrics)
44+
- [Scaling kube-state-metrics](#scaling-kube-state-metrics)
45+
- [Resource recommendation](#resource-recommendation)
46+
- [Latency](#latency)
47+
- [A note on costing](#a-note-on-costing)
48+
- [kube-state-metrics vs. metrics-server](#kube-state-metrics-vs-metrics-server)
49+
- [Horizontal sharding](#horizontal-sharding)
50+
- [Automated sharding](#automated-sharding)
51+
- [Daemonset sharding for pod metrics](#daemonset-sharding-for-pod-metrics)
52+
- [Setup](#setup)
53+
- [Building the Docker container](#building-the-docker-container)
54+
- [Usage](#usage)
55+
- [For users of prometheus-operator/kube-prometheus stack](#for-users-of-prometheus-operatorkube-prometheus-stack)
56+
- [Kubernetes Deployment](#kubernetes-deployment)
57+
- [Limited privileges environment](#limited-privileges-environment)
58+
- [Helm Chart](#helm-chart)
59+
- [Development](#development)
60+
- [Developer Contributions](#developer-contributions)
5861

5962
### Versioning
6063

@@ -72,13 +75,13 @@ At most, 5 kube-state-metrics and 5 [kubernetes releases](https://github.com/kub
7275
Generally, it is recommended to use the latest release of kube-state-metrics. If you run a very recent version of Kubernetes, you might want to use an unreleased version to have the full range of supported resources. If you run an older version of Kubernetes, you might need to run an older version in order to have full support for all resources. Be aware, that the maintainers will only support the latest release. Older versions might be supported by interested users of the community.
7376

7477
| kube-state-metrics | Kubernetes client-go Version |
75-
|--------------------|:----------------------------:|
76-
| **v2.6.0** | v1.24 |
77-
| **v2.7.0** | v1.25 |
78-
| **v2.8.2** | v1.26 |
79-
| **v2.9.2** | v1.26 |
80-
| **v2.10.0** | v1.27 |
81-
| **main** | v1.28 |
78+
| ------------------ | :--------------------------: |
79+
| **v2.6.0** | v1.24 |
80+
| **v2.7.0** | v1.25 |
81+
| **v2.8.2** | v1.26 |
82+
| **v2.9.2** | v1.26 |
83+
| **v2.10.0** | v1.27 |
84+
| **main** | v1.28 |
8285

8386
#### Resource group version compatibility
8487

0 commit comments

Comments
 (0)