Skip to content

OSDOCS10896: Update Custom Metrics Autoscaler documentation for ClusterTriggerAuthentication implementation#89402

Merged
mburke5678 merged 1 commit intoopenshift:mainfrom
mburke5678:podauto-custom-trig-auth
Mar 11, 2025
Merged

OSDOCS10896: Update Custom Metrics Autoscaler documentation for ClusterTriggerAuthentication implementation#89402
mburke5678 merged 1 commit intoopenshift:mainfrom
mburke5678:podauto-custom-trig-auth

Conversation

@mburke5678
Copy link
Contributor

@mburke5678 mburke5678 commented Feb 28, 2025

https://issues.redhat.com/browse/OSDOCS-10896

Preview:
Configuring the custom metrics autoscaler to use OpenShift Container Platform monitoring -- Myriad changes, including:

  • new 2nd paragraph;
  • Procedure step 1;
  • Procedure 2d;
  • Procedure 3a callout 1 only;
  • Procedure 5a callouts 1, 3 and 5 only;
  • Additional resources at end of module.

QE review:

  • QE has approved this change.

----
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
kind: RoleBinding <1>
Copy link
Member

Choose a reason for hiding this comment

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

Thoughts on this being <binding type> vs literal RoleBinding, so the user is forced to make a decision based on their situation?

@mburke5678
Copy link
Contributor Author

@prozehna Can you PTAL for QE. Thanks in advance!

@prozehna
Copy link
Contributor

prozehna commented Mar 5, 2025

At first check looks good, let me take a second one for my final comments.

@mburke5678
Copy link
Contributor Author

At first check looks good, let me take a second one for my final comments.

@prozehna Any further thoughts?

@prozehna
Copy link
Contributor

Apologies I didn't get back to you sooner. I can't find any issues nor nits.
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 10, 2025
@mburke5678 mburke5678 force-pushed the podauto-custom-trig-auth branch from fbb3523 to 9d7e570 Compare March 10, 2025 16:48
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Mar 10, 2025
@openshift-ci
Copy link

openshift-ci bot commented Mar 10, 2025

New changes are detected. LGTM label has been removed.

@mburke5678 mburke5678 added the peer-review-needed Signifies that the peer review team needs to review this PR label Mar 10, 2025
@jldohmann jldohmann added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Mar 10, 2025
Copy link
Contributor

@jldohmann jldohmann left a comment

Choose a reason for hiding this comment

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

mostly LGTM, just some clarification comments and nits below


You can use the installed {product-title} Prometheus monitoring as a source for the metrics used by the custom metrics autoscaler. However, there are some additional configurations you must perform.

For your scaled objects to be able to read the {product-title} Prometheus metrics, you must use a trigger authentication or a cluster trigger authentication in order to provide the authentication information required. The following procedure differs depending on which trigger authentication method you use. For more information on trigger authentications, see "Understanding custom metrics autoscaler trigger authentications".
Copy link
Contributor

Choose a reason for hiding this comment

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

can you add somewhere before the procedure that it is using the trigger authentication method? unless it's not, but based on the information contained in some of the codeblocks within the procedure that seems to be the case

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Made the procedure generic, for both auth methods.

* If you are using a trigger authentication, specify `TriggerAuthentication`.
* If you are using a cluster trigger authentication, specify `ClusterTriggerAuthentication`.
+
<2> Specifies that thi s object uses a secret for authorization.
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
<2> Specifies that thi s object uses a secret for authorization.
<2> Specifies that this object uses a secret for authorization.

----
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
kind: <binding_type> <1>
Copy link
Contributor

Choose a reason for hiding this comment

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

based on the other portions of this procedure where you are using TriggerAuthentication method parameters, i think it makes sense to stick with RoleBinding to be consistent

@jldohmann jldohmann added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 10, 2025
@mburke5678 mburke5678 force-pushed the podauto-custom-trig-auth branch from 9d7e570 to 4b737f5 Compare March 11, 2025 00:24
@openshift-ci
Copy link

openshift-ci bot commented Mar 11, 2025

@mburke5678: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@mburke5678 mburke5678 merged commit 389bfa9 into openshift:main Mar 11, 2025
2 checks passed
@mburke5678 mburke5678 deleted the podauto-custom-trig-auth branch March 11, 2025 00:49
@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.14

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.15

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.16

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.17

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.18

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.19

@openshift-cherrypick-robot

@mburke5678: new pull request created: #90016

Details

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #90017

Details

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #90018

Details

In response to this:

/cherrypick enterprise-4.16

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #90019

Details

In response to this:

/cherrypick enterprise-4.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #90020

Details

In response to this:

/cherrypick enterprise-4.18

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #90021

Details

In response to this:

/cherrypick enterprise-4.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants