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

feat(docs): add more configuration details to the HPA docs #6019

Merged
merged 7 commits into from
Nov 6, 2024

Conversation

lc525
Copy link
Member

@lc525 lc525 commented Oct 30, 2024

  • improve overall docs clarity
  • explain prometheus-adapter ConfigMap customisation options
  • mention that spec.replicas needs to be present in the Model CR for HPA to work
  • change apply to replace in kubectl command updating the prometheus-adapter ConfigMap
  • clarify in what namespaces we should load the various manifests in the example
  • add cluster operation guidelines for HPA-based autoscaling

@lc525 lc525 requested a review from sakoush as a code owner October 30, 2024 19:01
@lc525 lc525 added the v2 label Oct 30, 2024
@lc525 lc525 force-pushed the quickfix/hpa-docs branch 2 times, most recently from 5d9ff48 to 7c30b34 Compare October 31, 2024 14:54
@lc525 lc525 marked this pull request as draft October 31, 2024 14:54
@lc525 lc525 marked this pull request as ready for review October 31, 2024 14:54
@lc525 lc525 marked this pull request as draft October 31, 2024 14:55
@lc525 lc525 force-pushed the quickfix/hpa-docs branch 3 times, most recently from 8ed46ba to 046daa9 Compare October 31, 2024 19:23
@lc525 lc525 marked this pull request as ready for review October 31, 2024 19:26
@lc525 lc525 force-pushed the quickfix/hpa-docs branch 5 times, most recently from e109762 to 2d232de Compare November 1, 2024 09:41
@paulb-seldon
Copy link
Contributor

Should we link to this page so users understand the metrics Core 2 makes available to them (perhaps in the Installing and configuring the Prometheus Adapter) section?

@paulb-seldon
Copy link
Contributor

Consider renaming the section titled Seldon Core 2 scheduler interactions with HPA-based scaling? I think this is an important section, but I wouldn't know from the title that there is is relevant operational information there related to resource states, handling spikes, tips on configuration... perhaps something like Operational Guidelines for coordinating HPA Scaling and Core 2 Scheduling?

@paulb-seldon
Copy link
Contributor

I agree that this is long, however I do think we should keep it as is for now. Thankfully, there is the right side nav that outlines the high level sections.
Screenshot 2024-11-01 at 14 21 07

I would recommend perhaps simplifying the the titles of those sections if possible, and then I think that's enough for a user to have bearings when going through these docs. As we refactor IA of the docs more holistically, I think we will have to re-review content and how we break it up.

Copy link
Contributor

@paulb-seldon paulb-seldon left a comment

Choose a reason for hiding this comment

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

Overall LGTM. Have made some minor edits and possible suggestions in comments

lc525 and others added 3 commits November 1, 2024 19:16
* improve overall docs clarity
* explain prometheus-adapter ConfigMap customisation options
* mention that `spec.replicas` needs to be present in the Model CR for HPA to work
* change `apply` to `replace` in kubectl command updating the prometheus-adapter ConfigMap
* clarify in what namespaces we should load the various manifests in the example
* add cluster operation guidelines
@lc525 lc525 force-pushed the quickfix/hpa-docs branch 3 times, most recently from 08081b3 to 4d0b398 Compare November 1, 2024 19:48
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
docs-gb/kubernetes/hpa-rps-autoscaling.md Outdated Show resolved Hide resolved
Co-authored-by: Rajakavitha Kodhandapani <krajakavitha@gmail.com>
@lc525 lc525 merged commit 1ecc543 into SeldonIO:v2 Nov 6, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants