Add the blog post for the beta graduation of HPA ContainerResource type metric #39822

sanposhiho · 2023-03-06T23:30:58Z

The container resource metrics is planning to get graduated to beta in v1.27. So, the feature will be available for many people by default.
It’s worth sharing this feature and the motivation for people since this feature is very important to configure safe HPAs for Pod with multiple containers.

ref: kubernetes/enhancements#1610

sanposhiho · 2023-03-06T23:31:11Z

/area blog

sanposhiho · 2023-03-06T23:32:58Z

/sig autoscaling

…pe metric

sanposhiho · 2023-03-21T08:39:34Z

/sig autoscaling

sanposhiho · 2023-03-21T08:42:42Z

/cc @gjtempleton @mwielgus @pbetkier

netlify · 2023-03-21T08:53:32Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`2d0f3d4`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/64196cf11e614500082b2d1b
😎 Deploy Preview	https://deploy-preview-39822--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify · 2023-03-21T08:57:46Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`cbac72f`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/645198f93e7f2a00081dbd59
😎 Deploy Preview	https://deploy-preview-39822--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

gjtempleton

A couple of more general points:

I think we should call out the changes made by kubernetes/kubernetes#116045 given the potential for users to be looking at these events.
Could we introduce more detail on the metrics, including the labels on the metrics?

gjtempleton · 2023-03-21T10:18:37Z

content/en/blog/_posts/2023-04-13-hpa-container-resource-metric.md

+## What's new for the beta?
+
+For Kubernetes v1.27, the ContainerResource type metric will be available by default as described at the beginning.
+(You can still disable it by the `HPAContainerMetrics` feature gate.)
+
+On the instrumentation side, the kube-controller-manager reports the following new metrics([ref1](https://github.com/kubernetes/kubernetes/pull/116326), [ref2](https://github.com/kubernetes/kubernetes/pull/116010)):


Could we make clearer that this is a benefit even for those who won't make use of the promotion of the ContainerResources to beta.

gjtempleton · 2023-03-21T11:35:03Z

content/en/blog/_posts/2023-04-13-hpa-container-resource-metric.md

+In case a Pod has multiple containers, the utilization calculation would be:
+
+```
+sum{the resource usages of each container} / sum{the resource request of each container}


Suggested change

sum{the resource usages of each container} / sum{the resource request of each container}

sum{the resource usage of each container} / sum{the resource request of each container}

gjtempleton · 2023-03-21T11:55:44Z

content/en/blog/_posts/2023-04-13-hpa-container-resource-metric.md

+In case a Pod has multiple containers, the utilization calculation would be:
+
+```
+sum{the resource usages of each container} / sum{the resource request of each container}


Suggested change

sum{the resource usages of each container} / sum{the resource request of each container}

sum{the resource usage of each container} / sum{the resource request of each container}

gjtempleton · 2023-03-21T11:56:22Z

content/en/blog/_posts/2023-04-13-hpa-container-resource-metric.md

+
+So, even if one container's resource utilization goes high, the Resource type metric may not suggest scaling up.
+
+If your Pod has multiple containers, you may want to use the ContainerResource type metric instead for the accurate autoscaling.


Worth explicitly calling out an example where this might be useful (e.g. a logging or metrics sidecar)?

gjtempleton · 2023-03-21T11:58:36Z

content/en/blog/_posts/2023-04-13-hpa-container-resource-metric.md

+The ContainerResource type metric allows us to configure the autoscaling based on resource usage of individual containers.
+
+In the following example, the HPA controller scales the target 
+so that the average utilization of the cpu in the application container of all the pods is 60%.


This risks being slightly misleading, I would recommend linking out to the more detailed discussion of the algorithm in our docs given the edge cases including tolerance etc.

harshitasao · 2023-03-24T10:54:51Z

Hello, Comms Lead for the 1.27 release here. This feature blog is tracked for release, the deadline for submitting the draft is on 4th of April- the sooner the better since there's still editing to be done afterwards. Any doubt, the Comms team is here to help.
Thank you!

sanposhiho · 2023-03-26T05:04:29Z

@gjtempleton Thanks for reviews, please retake a look when have time 🙏

harshitasao · 2023-04-07T19:40:20Z

Hello, Comms Lead for v1.27 here. The publication order and date for the Feature Blog series has been finalized and the tracking board is updated.

The publication date for this article is 02-05-2023 (May 02).

Thank you!

harshitasao · 2023-04-11T15:23:11Z

content/en/blog/_posts/2023-04-13-hpa-container-resource-metric.md

+---
+layout: blog
+title: "HPA ContainerResource type metric moves to beta"
+date: 2023-04-11


Suggested change

date: 2023-04-11

date: 2023-05-02

Please also change the file path to match the new date.

harshitasao · 2023-04-26T19:01:46Z

@sanposhiho, friendly reminder for the above fixes.

sanposhiho · 2023-04-27T04:11:53Z

Ah, sorry for unnotice. I'll give a quick fix.

content/en/blog/_posts/2023-05-02-hpa-container-resource-metric.md

nate-double-u · 2023-05-02T22:22:28Z

A couple of things could be improved with spelling and word choice. Still, given its publication date is today, and we are already pushing other blog posts out, I'd like to approve this -- especially since it has a technical LGTM.

Reapplying @gjtempleton's tech lgtm:
/lgtm

Approving from a tech docs lens:
/approve

I'll open a PR to update the spelling and grammar shortly after approval.

k8s-ci-robot · 2023-05-02T22:22:39Z

LGTM label has been added.

Git tree hash: 087d203d485e7be473d334853006185776b88552

k8s-ci-robot · 2023-05-02T22:22:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: nate-double-u

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:

~~content/en/blog/OWNERS~~ [nate-double-u]

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

sftim

A few, important fixes.

content/en/blog/_posts/2023-05-02-hpa-container-resource-metric.md

Co-authored-by: Nate W. <[email protected]>

content/en/blog/_posts/2023-05-02-hpa-container-resource-metric.md

sftim

It's late, but perhaps still better to ship than not.

/lgtm
/hold cancel

k8s-ci-robot · 2023-05-02T23:13:17Z

LGTM label has been added.

Git tree hash: 3ea576cdefd8149537e727299e1c10fab1775c63

Review was stale due to maintainer changes

sftim · 2023-05-02T23:13:50Z

/label tide/merge-method-squash

sanposhiho · 2023-05-03T12:41:32Z

Thanks everyone for handling this 🙏

…pe metric (kubernetes#39822) * Add the blog post for the beta graduation of HPA ContainerResource type metric * fix based on reviews * fix based on the suggestion * fix based on review * update date * Apply changes from code review Co-authored-by: Nate W. <[email protected]> * Push back publication date and timezone --------- Co-authored-by: Tim Bannister <[email protected]> Co-authored-by: Nate W. <[email protected]>

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 6, 2023

k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 6, 2023

k8s-ci-robot added the sig/autoscaling Categorizes an issue or PR as relevant to SIG Autoscaling. label Mar 6, 2023

sanposhiho marked this pull request as ready for review March 21, 2023 08:38

k8s-ci-robot requested review from nate-double-u and onlydole March 21, 2023 08:38

Add the blog post for the beta graduation of HPA ContainerResource ty…

68859ab

…pe metric

sanposhiho force-pushed the hpa-container branch from 2d0f3d4 to 68859ab Compare March 21, 2023 08:39

sanposhiho changed the title ~~WIP: HPA container resource metrics blog~~ Add the blog post for the beta graduation of HPA ContainerResource type metric Mar 21, 2023

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2023

k8s-ci-robot requested review from gjtempleton, mwielgus and pbetkier March 21, 2023 08:42

gjtempleton suggested changes Mar 21, 2023

View reviewed changes

fix based on reviews

6656036

sanposhiho mentioned this pull request Mar 26, 2023

Container Resource based Pod Autoscaling kubernetes/enhancements#1610

Closed

harshitasao reviewed Apr 11, 2023

View reviewed changes

update date

5de5f44

nate-double-u reviewed May 2, 2023

View reviewed changes

content/en/blog/_posts/2023-05-02-hpa-container-resource-metric.md Outdated Show resolved Hide resolved

nate-double-u reviewed May 2, 2023

View reviewed changes

content/en/blog/_posts/2023-05-02-hpa-container-resource-metric.md Outdated Show resolved Hide resolved

k8s-ci-robot assigned nate-double-u May 2, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 2, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 2, 2023

sftim previously requested changes May 2, 2023

View reviewed changes

Apply changes from code review

96aba3e

Co-authored-by: Nate W. <[email protected]>

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 2, 2023

k8s-ci-robot requested a review from nate-double-u May 2, 2023 23:11

sftim reviewed May 2, 2023

View reviewed changes

content/en/blog/_posts/2023-05-02-hpa-container-resource-metric.md Outdated Show resolved Hide resolved

Push back publication date and timezone

cbac72f

sftim reviewed May 2, 2023

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 2, 2023

k8s-ci-robot assigned sftim May 2, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 2, 2023

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 2, 2023

k8s-ci-robot merged commit 73437c2 into kubernetes:main May 2, 2023

	sum{the resource usages of each container} / sum{the resource request of each container}
	sum{the resource usage of each container} / sum{the resource request of each container}


		So, even if one container's resource utilization goes high, the Resource type metric may not suggest scaling up.

		If your Pod has multiple containers, you may want to use the ContainerResource type metric instead for the accurate autoscaling.

Add the blog post for the beta graduation of HPA ContainerResource type metric #39822

Add the blog post for the beta graduation of HPA ContainerResource type metric #39822

Uh oh!

Conversation

sanposhiho commented Mar 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sanposhiho commented Mar 6, 2023

Uh oh!

sanposhiho commented Mar 6, 2023

Uh oh!

sanposhiho commented Mar 21, 2023

Uh oh!

sanposhiho commented Mar 21, 2023

Uh oh!

netlify bot commented Mar 21, 2023

✅ Pull request preview available for checking

Uh oh!

netlify bot commented Mar 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull request preview available for checking

Uh oh!

gjtempleton left a comment

Choose a reason for hiding this comment

Uh oh!

gjtempleton Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

gjtempleton Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

gjtempleton Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

gjtempleton Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

gjtempleton Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

harshitasao commented Mar 24, 2023

Uh oh!

sanposhiho commented Mar 26, 2023

Uh oh!

harshitasao commented Apr 7, 2023

Uh oh!

harshitasao Apr 11, 2023

Choose a reason for hiding this comment

Uh oh!

harshitasao commented Apr 26, 2023

Uh oh!

sanposhiho commented Apr 27, 2023

Uh oh!

Uh oh!

Uh oh!

nate-double-u commented May 2, 2023

Uh oh!

k8s-ci-robot commented May 2, 2023

Uh oh!

k8s-ci-robot commented May 2, 2023

Uh oh!

sftim left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sftim left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented May 2, 2023

Uh oh!

sftim commented May 2, 2023

sanposhiho commented Mar 6, 2023 •

edited

Loading

netlify bot commented Mar 21, 2023 •

edited

Loading