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

Fixing #5537: Adding mandatory target annotation and their units. #5629

Merged
merged 16 commits into from
Jul 31, 2023

Conversation

erharjotsingh
Copy link
Contributor

"Fixes #5537 : Adding mandatory target annotation and their units."

Proposed Changes

  • Add sample code for target annotation which is mandatory
  • Added comments for specifying units of the autoscaling types

…ry target values

As per issue  knative#5537,  creating this PR for adding mandatory target annotation.
Issue# knative#5537: Update autoscaling-metrics.md to add the mandatory targ…
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 17, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@netlify
Copy link

netlify bot commented Jul 17, 2023

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c92dfc5
🔍 Latest deploy log https://app.netlify.com/sites/knative/deploys/64c53e72d053ae0008259bc6
😎 Deploy Preview https://deploy-preview-5629--knative.netlify.app/docs/serving/autoscaling/autoscaling-metrics
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@knative-prow knative-prow bot requested review from nak3 and ReToCode July 17, 2023 11:02
@knative-prow
Copy link

knative-prow bot commented Jul 17, 2023

Welcome @erharjotsingh! It looks like this is your first PR to knative/docs 🎉

@knative-prow knative-prow bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 17, 2023
@@ -32,6 +32,8 @@ For more information about KPA and HPA, see the documentation on [Supported Auto
metadata:
annotations:
autoscaling.knative.dev/metric: "concurrency"
autoscaling.knative.dev/target-utilization-percentage: "70"
#autoscaling.knative.dev/target-utilization-percentage sepcifies a percentage value which when reached autoscaling is performed
Copy link
Contributor

Choose a reason for hiding this comment

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

rather than making these types of comments in the yaml (which isn't super easy to read), it might be better to put this info after the yaml block

Copy link
Contributor Author

@erharjotsingh erharjotsingh Jul 24, 2023

Choose a reason for hiding this comment

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

Hello @psschwei
Many thanks for your feedback. I have performed the suggested changes. Kindly review and thanks again!

@knative-prow knative-prow bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 24, 2023
Reverting the commit for other issue so that I can fork one branch per issue
@knative-prow knative-prow bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 24, 2023
```
# autoscaling.knative.dev/target-utilization-percentage annotation for "Concurrency" sepcifies a percentage value which when reached autoscaling is performed
Copy link
Contributor

Choose a reason for hiding this comment

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

This breaks the page formatting -- these need to be indented and have the # removed

image

Copy link
Contributor

Choose a reason for hiding this comment

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

A preview gets built on each commit you add: #5629 (comment) (or you can build locally and preview that way too)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @psschwei for sharing information about preview feature. Currently I am redirected to knative homepage when I click the preview link. https://deploy-preview-5629--knative.netlify.app/

Copy link
Contributor

@psschwei psschwei Jul 25, 2023

Choose a reason for hiding this comment

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

Copy link
Contributor Author

@erharjotsingh erharjotsingh Jul 26, 2023

Choose a reason for hiding this comment

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

Hello @psschwei Thanks for showing the link. I have submitted another PR. Kindly review. Thanks!
https://deploy-preview-5629--knative.netlify.app/docs/serving/autoscaling/autoscaling-metrics/

Comment on lines 35 to 37
autoscaling.knative.dev/target-utilization-percentage: "70"
```
autoscaling.knative.dev/target-utilization-percentage annotation for "Concurrency" specifies a percentage value
Copy link
Contributor

Choose a reason for hiding this comment

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

You'll need to indent all the comments, otherwise it breaks the layout. It also might be nice to format them as notes, i.e.

Suggested change
autoscaling.knative.dev/target-utilization-percentage: "70"
```
autoscaling.knative.dev/target-utilization-percentage annotation for "Concurrency" specifies a percentage value
autoscaling.knative.dev/target-utilization-percentage: "70"
```
!!! note
The `autoscaling.knative.dev/target-utilization-percentage` annotation for "Concurrency" specifies a percentage value

This should be done for all the updates

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello @psschwei
Sure, I added the note section and content to next line by splitting it by br tag. enter was not working to move the content to next line same line as viewed in preview section.

@knative-prow knative-prow bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 27, 2023
Copy link
Contributor

@psschwei psschwei left a comment

Choose a reason for hiding this comment

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

Again, you need to align these properly so as to not break the formatting... please check the preview to ensure the page is rendering properly (compare with the existing doc page if needed)

Comment on lines 35 to 37
autoscaling.knative.dev/target-utilization-percentage: "70"
```
!!! note <br/>
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
autoscaling.knative.dev/target-utilization-percentage: "70"
```
!!! note <br/>
autoscaling.knative.dev/target-utilization-percentage: "70"
```
!!! note <br/>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @psschwei , I have compared the existing page and changes looks fine to me. Kindly review. Thanks again for your help!

Comment on lines 36 to 39
```
!!! note <br/>
The `autoscaling.knative.dev/target-utilization-percentage` annotation for "Concurrency"
<br/> specifies a percentage value
Copy link
Contributor

Choose a reason for hiding this comment

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

These still aren't rendering properly...

image

Indents blocks are four spaces, and you don't need the the <br/> tags at all.

Suggested change
```
!!! note <br/>
The `autoscaling.knative.dev/target-utilization-percentage` annotation for "Concurrency"
<br/> specifies a percentage value
```
!!! note
The `autoscaling.knative.dev/target-utilization-percentage` annotation for "Concurrency" specifies a percentage value

It should look like this:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure @psschwei Performed the suggested change. Thanks.

Copy link
Contributor

@psschwei psschwei left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jul 31, 2023
@knative-prow
Copy link

knative-prow bot commented Jul 31, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: erharjotsingh, psschwei

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

@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 31, 2023
@knative-prow knative-prow bot merged commit 9c9f95e into knative:main Jul 31, 2023
16 checks passed
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. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

autoscaling metric type - memory, not working (always create cpu metric based hpa)
2 participants