Add DatadogPodAutoscaler manifest reference - #39378
Conversation
…ng overview Co-authored-by: clamoriniere <cedric.lamoriniere@datadoghq.com>
|
I can only run on private repositories. |
Preview links (active after the
|
Co-authored-by: clamoriniere <cedric.lamoriniere@datadoghq.com>
clamoriniere
left a comment
There was a problem hiding this comment.
few requires change needed for the content
Co-authored-by: clamoriniere <cedric.lamoriniere@datadoghq.com>
Co-authored-by: clamoriniere <cedric.lamoriniere@datadoghq.com>
|
Created DOCS-15498 for editorial review. |
|
/review |
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Overall this is a well-structured, high-quality PR that adds a much-needed manifest reference and cleanly refactors the in-place vertical scaling coverage in _index.md. A few minor style-level nits below.
Reviewed c93aa6618ac75bd78b94fa8e2737a60fd1bf3daa — workflow run
| [7]: https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ | ||
| [8]: /integrations/datadog-cluster-agent/#metrics | ||
| [9]: /help/ | ||
| [10]: /containers/guide/container-discovery-management/ |
There was a problem hiding this comment.
Style: The reference-link numbering skips [4], [5], and [6] (goes 1, 2, 3, 7, 8, 9, 10). Looks like it was copied from _index.md. Renumber sequentially so the definitions match the in-text references:
| [10]: /containers/guide/container-discovery-management/ | |
| [1]: https://app.datadoghq.com/orchestration/scaling/workload | |
| [2]: /containers/autoscaling/ | |
| [3]: /containers/autoscaling/#in-place-vertical-scaling | |
| [4]: https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ | |
| [5]: /integrations/datadog-cluster-agent/#metrics | |
| [6]: /help/ | |
| [7]: /containers/guide/container-discovery-management/ |
(You'll also need to update the in-text references [7], [8], [9], [10] accordingly.)
|
I think users will benefit if we also add these details to the DPA CRD such that they are discoverable by agents via |
Co-authored-by: clamoriniere <cedric.lamoriniere@datadoghq.com>
it is a good idea, I will open a follow-up PR on datadog-operator repo to add more comment on the CRD definition https://github.com/DataDog/datadog-operator/blob/main/api/datadoghq/v1alpha1/datadogpodautoscaler_types.go |
|
/review |
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Nice restructuring: hoisting in-place vertical scaling into its own top-level section and pulling manifest details into a dedicated reference page reads well. A few small nits on hyphenation consistency and one clarity question on the OOMKill + RequestsOnly interaction.
Reviewed 0ed0e06c5c0816aaf5ee3d4c400d0a0bcde1c4ca — workflow run
Co-authored-by: clamoriniere <cedric.lamoriniere@datadoghq.com>
What does this PR do? What is the motivation?
Adds a new sub-page, DatadogPodAutoscaler manifest reference, documenting
DatadogPodAutoscaler(DPA) configuration options that are only available by editing the manifest and were not previously covered in the docs. It also makes targeted updates to the Kubernetes Autoscaling overview so the two pages stay consistent and correct.Changes
New page
containers/autoscaling/manifest.md:required/optionalmarkers), supported target workloads, and how to choose a scaling mode.controlledResources(CPU and memory rightsizing, with the memory-only default when combined with horizontal scaling),controlledValues(RequestsAndLimits/RequestsOnly),minAllowed/maxAllowed,enabled, and"*"wildcard non-merge semantics.options.burstable), OOMKill bump tuning (options.outOfMemory.bumpUpRatio), sidecars (including native sidecars), vertical rollout timing (resizePendingPeriod/rolloutFallbackDelay), andContainerResource/AbsoluteValue/CustomQuery(includingApmMetrics) objectives, plus telemetry tagging.Updates to
containers/autoscaling/_index.md:inPlaceVerticalScaling(Operator and Helm) and added a dedicated In-place vertical scaling section.Navigation:
Review feedback addressed:
objectivesalso feeds multidimensional scaling, emphasized that autoscaled containers must not be excluded from Agent collection (with a link to Container Discovery Management), corrected the scale-down comment, marked custom-query-with-vertical-scaling as not supported, documented in-place support at Kubernetes 1.33+ with the startup/downward-API caveat, and clarified that an OOMKill raises the memory limit and potentially the request./reviewsuggestions: promoted the remaining inline external URLs in the in-place section to reference-style links, renumbered the manifest reference list sequentially, reconciled the vertical-only instruction with the "Choose a scaling mode" table, broke the dense Kubernetes-limitations sentence into a nested bullet list, made the API-version sentence clearer, capitalized theNotesentence, and made hyphenation ofrightsizingconsistent.Testing / validation
tabs/tab) and fenced code blocks in both changed pages.Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Drafted with Bits Code (Claude Code): converted a source reference document into the new page, applied Datadog documentation style, made the consistency edits to the overview, and addressed reviewer feedback (human and automated). Reviewed by the author.
Additional notes
No Jira ticket is associated with this change. StatefulSet is documented as a fully supported target workload per maintainer guidance. The ArgoCD and Terraform guides were intentionally left unchanged.
PR by Bits - View session in Datadog
Comment @DataDog to request changes