Skip to content

Commit d67b142

Browse files
committed
addressing reviews & fixing CI errors
1 parent 1ed3617 commit d67b142

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ assignees: ''
99

1010
<!-- Please only use this template for submitting feature requests -->
1111

12-
**What would you like to be added**:
12+
**What would you like to be added:**
1313

14-
**Why is this needed**:
14+
**Why is this needed:**
1515

16-
**Describe the solution you'd like**:
16+
**Describe the solution you'd like:**
1717

18-
**Additional context**:
18+
**Additional context:**

README.md.tpl

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -145,15 +145,15 @@ at the logs of kube-state-metrics.
145145

146146
Example of the above mentioned metrics:
147147

148-
```
148+
```prometheus
149149
kube_state_metrics_list_total{resource="*v1.Node",result="success"} 1
150150
kube_state_metrics_list_total{resource="*v1.Node",result="error"} 52
151151
kube_state_metrics_watch_total{resource="*v1beta1.Ingress",result="success"} 1
152152
```
153153

154154
kube-state-metrics also exposes some http request metrics, examples of those are:
155155

156-
```
156+
```prometheus
157157
http_request_duration_seconds_bucket{handler="metrics",method="get",le="2.5"} 30
158158
http_request_duration_seconds_bucket{handler="metrics",method="get",le="5"} 30
159159
http_request_duration_seconds_bucket{handler="metrics",method="get",le="10"} 30
@@ -164,7 +164,7 @@ http_request_duration_seconds_count{handler="metrics",method="get"} 30
164164

165165
kube-state-metrics also exposes build and configuration metrics:
166166

167-
```
167+
```prometheus
168168
kube_state_metrics_build_info{branch="main",goversion="go1.15.3",revision="6c9d775d",version="v2.0.0-beta"} 1
169169
kube_state_metrics_shard_ordinal{shard_ordinal="0"} 0
170170
kube_state_metrics_total_shards 1
@@ -177,7 +177,7 @@ run-time configuration, see [`/examples/prometheus-alerting-rules`](./examples/p
177177

178178
kube-state-metrics also exposes metrics about it config file and the Custom Resource State config file:
179179

180-
```
180+
```prometheus
181181
kube_state_metrics_config_hash{filename="crs.yml",type="customresourceconfig"} 2.38272279311849e+14
182182
kube_state_metrics_config_hash{filename="config.yml",type="config"} 2.65285922340846e+14
183183
kube_state_metrics_last_config_reload_success_timestamp_seconds{filename="crs.yml",type="customresourceconfig"} 1.6704882592037103e+09
@@ -204,7 +204,7 @@ Note that if CPU limits are set too low, kube-state-metrics' internal queues wil
204204

205205
In a 100 node cluster scaling test the latency numbers were as follows:
206206

207-
```
207+
```text
208208
"Perc50": 259615384 ns,
209209
"Perc90": 475000000 ns,
210210
"Perc99": 906666666 ns.
@@ -268,7 +268,7 @@ Each kube-state-metrics pod uses FieldSelector (spec.nodeName) to watch/list pod
268268

269269
A daemonset kube-state-metrics example:
270270

271-
```
271+
```yaml
272272
apiVersion: apps/v1
273273
kind: DaemonSet
274274
spec:
@@ -290,7 +290,7 @@ spec:
290290

291291
To track metrics for unassigned pods, you need to add an additional deployment and set `--track-unscheduled-pods`, as shown in the following example:
292292

293-
```
293+
```yaml
294294
apiVersion: apps/v1
295295
kind: Deployment
296296
spec:
@@ -316,16 +316,16 @@ When scraping the individual pods directly in an HA setup, Prometheus will inges
316316

317317
Install this project to your `$GOPATH` using `go get`:
318318

319-
```
320-
go get k8s.io/kube-state-metrics
319+
```bash
320+
go get k8s.io/kube-state-metrics/v2
321321
```
322322

323323
#### Building the Docker container
324324

325325
Simply run the following command in this root folder, which will create a
326326
self-contained, statically-linked binary and build a Docker image:
327327

328-
```
328+
```bash
329329
make container
330330
```
331331

@@ -348,7 +348,7 @@ To have Prometheus discover kube-state-metrics instances it is advised to create
348348

349349
**Note:** Google Kubernetes Engine (GKE) Users - GKE has strict role permissions that will prevent the kube-state-metrics roles and role bindings from being created. To work around this, you can give your GCP identity the cluster-admin role by running the following one-liner:
350350

351-
```
351+
```bash
352352
kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user=$(gcloud info --format='value(config.account)')
353353
```
354354

@@ -423,14 +423,14 @@ When developing, test a metric dump against your local Kubernetes cluster by run
423423

424424
> Users can override the apiserver address in KUBE-CONFIG file with `--apiserver` command line.
425425

426-
```
426+
```bash
427427
go install
428428
kube-state-metrics --port=8080 --telemetry-port=8081 --kubeconfig=<KUBE-CONFIG> --apiserver=<APISERVER>
429429
```
430430

431431
Then curl the metrics endpoint
432432

433-
```
433+
```bash
434434
curl localhost:8080/metrics
435435
```
436436

0 commit comments

Comments
 (0)