From 8bce8e78c56569441a335d0adb4f432829acc42a Mon Sep 17 00:00:00 2001
From: rashmichandrashekar <rashmy@microsoft.com>
Date: Wed, 6 Nov 2024 18:08:49 -0800
Subject: [PATCH] Update HPA doc to add min=max behavior (#1009)

[comment]: # (Note that your PR title should follow the conventional
commit format: https://conventionalcommits.org/en/v1.0.0/#summary)
# PR Description
Update doc to add min=max behavior

[comment]: # (The below checklist is for PRs adding new features. If a
box is not checked, add a reason why it's not needed.)
# New Feature Checklist

- [ ] List telemetry added about the feature.
- [ ] Link to the one-pager about the feature.
- [ ] List any tasks necessary for release (3P docs, AKS RP chart
changes, etc.) after merging the PR.
- [ ] Attach results of scale and perf testing.

[comment]: # (The below checklist is for code changes. Not all boxes
necessarily need to be checked. Build, doc, and template changes do not
need to fill out the checklist.)
# Tests Checklist

- [ ] Have end-to-end Ginkgo tests been run on your cluster and passed?
To bootstrap your cluster to run the tests, follow [these
instructions](/otelcollector/test/README.md#bootstrap-a-dev-cluster-to-run-ginkgo-tests).
  - Labels used when running the tests on your cluster:
    - [ ] `operator`
    - [ ] `windows`
    - [ ] `arm64`
    - [ ] `arc-extension`
    - [ ] `fips`
- [ ] Have new tests been added? For features, have tests been added for
this feature? For fixes, is there a test that could have caught this
issue and could validate that the fix works?
  - [ ] Is a new scrape job needed?
- [ ] The scrape job was added to the folder
[test-cluster-yamls](/otelcollector/test/test-cluster-yamls/) in the
correct configmap or as a CR.
  - [ ] Was a new test label added?
- [ ] A string constant for the label was added to
[constants.go](/otelcollector/test/utils/constants.go).
- [ ] The label and description was added to the [test
README](/otelcollector/test/README.md).
- [ ] The label was added to this [PR
checklist](/.github/pull_request_template).
- [ ] The label was added as needed to
[testkube-test-crs.yaml](/otelcollector/test/testkube/testkube-test-crs.yaml).
  - [ ] Are additional API server permissions needed for the new tests?
- [ ] These permissions have been added to
[api-server-permissions.yaml](/otelcollector/test/testkube/api-server-permissions.yaml).
  - [ ] Was a new test suite (a new folder under `/tests`) added?
- [ ] The new test suite is included in
[testkube-test-crs.yaml](/otelcollector/test/testkube/testkube-test-crs.yaml).

Co-authored-by: Vishwanath <visnara@microsoft.com>
---
 internal/docs/HPA.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/internal/docs/HPA.md b/internal/docs/HPA.md
index acc844b5..b5a75546 100644
--- a/internal/docs/HPA.md
+++ b/internal/docs/HPA.md
@@ -44,5 +44,14 @@ You could also edit the min and max replicas by doing a **kubectl edit** and upd
 kubectl edit hpa ama-metrics-hpa -n kube-system
 ```
 
+### Update min and max shards to disable HPA scaling
+HPA should be able to handle the load automatically for varying customer needs. But, it it doesnt fit the needs you can set min shards = max shards so that HPA doesnt scale the replicas based on the varying loads. 
+
+Ex - If the customer wants to set the shards to 8 and not have the HPA update the shards, update the min and max shards to 8.
+
+**Update Min and Max replicas**
+```bash
+kubectl patch hpa ama-metrics-hpa -n kube-system --type merge --patch '{"spec": {"minReplicas": 8, "maxReplicas": 8}}'
+```