Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2021-03-31-kube-state-metrics-goes-v-2-0.md: Add kube-state-metrics 2.0 #27324

Merged
merged 1 commit into from
Apr 12, 2021

Conversation

lilic
Copy link
Member

@lilic lilic commented Mar 30, 2021

Add kube-state-metrics 2.0 blog post announcement. As kube-state-metrics v2.0.0 is going to be released next week, (unless any bugs are reported - we have v2.0.0-rc.1 out), we wanted to have a blog post that accompanies this, as we had a bunch of user breaking changes.

/hold
I put it on hold until kube-state-metrics v2.0.0 is out, but wanted to open the PR so folks can review, the other maintainers already had a look, but are cc-ed below.

@mrueg @brancz @tariq1890

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 30, 2021
@k8s-ci-robot k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 30, 2021
@netlify
Copy link

netlify bot commented Mar 30, 2021

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 211187a

https://deploy-preview-27324--kubernetes-io-master-staging.netlify.app

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lilic - I've reviewed this as best I can and I hope the feedback helps.

@lilic
Copy link
Member Author

lilic commented Apr 6, 2021

Thanks @mrueg and @sftim for the reviews, I applied the suggestions, please have another look, thanks!


## Why?

After deploying kube-state-metrics it provides you with an array of useful metrics about the state of your cluster out of the box! These metrics can be used to serve as an insight into your cluster: Either through metrics alone, in the form of dashboards, or through an alerting pipeline. They can especially be useful to troubleshoot an outage. A metric worth pointing out is `kube_pod_container_status_restarts_total` which can be used to alert you on a crashing pod. Another helpful metric is `kube_deployment_status_replicas` which together with `kube_deployment_status_replicas_available` can be used to alert on whether a deployment is rolled out successfully or stuck. And there are many more metrics available! If you are interested in further metrics and their details, check out the [documentation](https://github.com/kubernetes/kube-state-metrics/tree/master/docs#readme).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After deploying kube-state-metrics it provides you with an array of useful metrics about the state of your cluster out of the box! These metrics can be used to serve as an insight into your cluster: Either through metrics alone, in the form of dashboards, or through an alerting pipeline. They can especially be useful to troubleshoot an outage. A metric worth pointing out is `kube_pod_container_status_restarts_total` which can be used to alert you on a crashing pod. Another helpful metric is `kube_deployment_status_replicas` which together with `kube_deployment_status_replicas_available` can be used to alert on whether a deployment is rolled out successfully or stuck. And there are many more metrics available! If you are interested in further metrics and their details, check out the [documentation](https://github.com/kubernetes/kube-state-metrics/tree/master/docs#readme).
`kube-state-metrics` provides you with a wide range of useful metrics about the state of your Kubernetes cluster out of the box! These metrics can be used to serve as an insight into your cluster: Either through metrics alone, in the form of dashboards, or through an alerting pipeline. They can especially be useful to troubleshoot an outage. To provide a few examples:
i) `kube_pod_container_status_restarts_total` can be used to alert on a crashing pod.
ii)`kube_deployment_status_replicas` which together with `kube_deployment_status_replicas_available` can be used to alert on whether a deployment is rolled out successfully or stuck.
And there are many more metrics available at your disposal! To learn more about the other metrics and their details, please check out the [documentation](https://github.com/kubernetes/kube-state-metrics/tree/master/docs#readme).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like that the start of the sentence isn't kube-state-metrics, if you can suggest another way, I would prefer to go that way, if that's okay?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe A wide range of useful metrics about the state of your Kubernetes cluster is provided by `kube-state-metrics` out of the box!

Copy link
Member

@mrbobbytables mrbobbytables Apr 12, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do like the breakout format of the examples - for the intro piece I and was thinking something along the same lines as @mrueg .
"There are numerous useful metrics and insights provided by kube-state-metrics right out of the box!"

EDIT: not a blocker

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, thanks all! I added also another example as two is not a nice number :D

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 12, 2021
@lilic
Copy link
Member Author

lilic commented Apr 12, 2021

Please have another look, I addressed the changes and removed the full list of the CHANGELOG and instead linked to it.

@mrbobbytables mrbobbytables added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Apr 12, 2021
@lilic lilic force-pushed the add-ksm-2.0 branch 2 times, most recently from ebcce99 to 7157294 Compare April 12, 2021 13:20
@lilic
Copy link
Member Author

lilic commented Apr 12, 2021

I also opened kubernetes/kube-state-metrics#1449 🎉

@sftim
Copy link
Contributor

sftim commented Apr 12, 2021

Article preview

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Needs a confirmed release date.

@mrbobbytables
Copy link
Member

Things look good :) @lilic can you update the address of the filename to be tomorrow's date?

@lilic
Copy link
Member Author

lilic commented Apr 12, 2021

@mrbobbytables done, thanks!

@mrbobbytables
Copy link
Member

/lgtm
(from @sftim's lgtm)
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 12, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 81fea6c8f44d71e1d5a75eda49e91848c217c1de

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrbobbytables, mrueg

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 12, 2021
@lilic
Copy link
Member Author

lilic commented Apr 12, 2021

/hold cancel

🎉 Thank you all!

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 12, 2021
@k8s-ci-robot k8s-ci-robot merged commit 9913520 into kubernetes:master Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants