From 0f6aa0a2e1a98b1c477812765273105429e90af9 Mon Sep 17 00:00:00 2001 From: CatherineF-dev Date: Thu, 11 Jan 2024 09:29:52 -0500 Subject: [PATCH 1/3] Add guide on how to debug CustomStateMetrics feature quickly --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5b75994395..955910b2fb 100644 --- a/README.md +++ b/README.md @@ -406,6 +406,14 @@ Then curl the metrics endpoint To run the e2e tests locally see the documentation in [tests/README.md](./tests/README.md). +##### Debug CustomStateMetrics feature +``` +minikube start +... +go run main.go --custom-resource-state-only --custom-resource-state-config-file ksm-2223/custom-resource-config-file.yaml --kubeconfig ~/.kube/config +``` +See more details in https://github.com/kubernetes/kube-state-metrics/issues/2223#issuecomment-1792850276 + #### Developer Contributions When developing, there are certain code patterns to follow to better your contributing experience and likelihood of e2e and other ci tests to pass. To learn more about them, see the documentation in [docs/developer/guide.md](./docs/developer/guide.md). From 9d9f8729d82d3f3540b91540bb70b3dd7236399c Mon Sep 17 00:00:00 2001 From: CatherineF-dev Date: Thu, 11 Jan 2024 09:33:04 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 955910b2fb..1a9b857e15 100644 --- a/README.md +++ b/README.md @@ -407,11 +407,13 @@ Then curl the metrics endpoint To run the e2e tests locally see the documentation in [tests/README.md](./tests/README.md). ##### Debug CustomStateMetrics feature -``` + +```bash minikube start ... go run main.go --custom-resource-state-only --custom-resource-state-config-file ksm-2223/custom-resource-config-file.yaml --kubeconfig ~/.kube/config ``` + See more details in https://github.com/kubernetes/kube-state-metrics/issues/2223#issuecomment-1792850276 #### Developer Contributions From 0cb952a1162d8d7028a251861c3ecb8da6fbfcc4 Mon Sep 17 00:00:00 2001 From: CatherineF-dev Date: Thu, 11 Jan 2024 09:35:09 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a9b857e15..92dda792d7 100644 --- a/README.md +++ b/README.md @@ -414,7 +414,7 @@ minikube start go run main.go --custom-resource-state-only --custom-resource-state-config-file ksm-2223/custom-resource-config-file.yaml --kubeconfig ~/.kube/config ``` -See more details in https://github.com/kubernetes/kube-state-metrics/issues/2223#issuecomment-1792850276 +See more details [here](https://github.com/kubernetes/kube-state-metrics/issues/2223#issuecomment-1792850276) #### Developer Contributions