Add Comprehensive VPA Documentation to Kubernetes Website

[omerap12]

With kubernetes/website#53345 now merged, and kubernetes/website#53354
expected to merge soon, we’ve officially kicked off the VPA documentation on the Kubernetes website. You can already read the initial content here: https://kubernetes.io/docs/concepts/workloads/autoscaling/vertical-pod-autoscale/

We’d like to keep the momentum going by expanding the VPA docs with more details on how it works, supported features, best practices, and other relevant information. This issue serves as a central tracking point for contributors interested in helping improve and grow the VPA documentation on the Kubernetes site.

/good-first-issue
/kind documentation
/cc @adrianmoisey

[k8s-ci-robot]

@omerap12:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

• Why are we solving this issue?
• To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
• How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

With kubernetes/website#53345 now merged, and kubernetes/website#53354
expected to merge soon, we’ve officially kicked off the VPA documentation on the Kubernetes website. You can already read the initial content here: https://kubernetes.io/docs/concepts/workloads/autoscaling/vertical-pod-autoscale/

We’d like to keep the momentum going by expanding the VPA docs with more details on how it works, supported features, best practices, and other relevant information. This issue serves as a central tracking point for contributors interested in helping improve and grow the VPA documentation on the Kubernetes site.

/good-first-issue
/kind documentation
/cc @adrianmoisey

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.

[iamzili]

Hey!

what is the end goal for the write-up on the official k8s website compared to what we currently have in the autoscaler git repo under vertical-pod-autoscaler/docs? Is the plan to eventually move content from the docs folder to the official k8s website and remove it from the repo (as we don't want to maintain the same stuff twice), or should we keep the existing docs in place, continue improving them, and use the official site only for a high-level overview of VPA?

[omerap12]

Hey!

what is the end goal for the write-up on the official k8s website compared to what we currently have in the autoscaler git repo under vertical-pod-autoscaler/docs? Is the plan to eventually move content from the docs folder to the official k8s website and remove it from the repo (as we don't want to maintain the same stuff twice), or should we keep the existing docs in place, continue improving them, and use the official site only for a high-level overview of VPA?

The official Kubernetes docs should focus on providing a high-level overview of the VPA - its key features and how to use them. We don’t need to go into the level of detail we would for an AEP proposal, but we do need to clearly describe the various capabilities the VPA offers (startup boost, in-place updates, per-VPA configuration, and so on). The deeper, design-focused documentation can remain in the repo, while the website serves as the user-facing overview.

[omerap12]

/triage accepted

[adrianmoisey]

/area vertical-pod-autoscaler

[iamzili]

Hey!
what is the end goal for the write-up on the official k8s website compared to what we currently have in the autoscaler git repo under vertical-pod-autoscaler/docs? Is the plan to eventually move content from the docs folder to the official k8s website and remove it from the repo (as we don't want to maintain the same stuff twice), or should we keep the existing docs in place, continue improving them, and use the official site only for a high-level overview of VPA?

The official Kubernetes docs should focus on providing a high-level overview of the VPA - its key features and how to use them. We don’t need to go into the level of detail we would for an AEP proposal, but we do need to clearly describe the various capabilities the VPA offers (startup boost, in-place updates, per-VPA configuration, and so on). The deeper, design-focused documentation can remain in the repo, while the website serves as the user-facing overview.

understood, I can extend the official website to include the in-place updates section. I assume I just need to raise a PR against https://github.com/kubernetes/website

[omerap12]

Hey!
what is the end goal for the write-up on the official k8s website compared to what we currently have in the autoscaler git repo under vertical-pod-autoscaler/docs? Is the plan to eventually move content from the docs folder to the official k8s website and remove it from the repo (as we don't want to maintain the same stuff twice), or should we keep the existing docs in place, continue improving them, and use the official site only for a high-level overview of VPA?

The official Kubernetes docs should focus on providing a high-level overview of the VPA - its key features and how to use them. We don’t need to go into the level of detail we would for an AEP proposal, but we do need to clearly describe the various capabilities the VPA offers (startup boost, in-place updates, per-VPA configuration, and so on). The deeper, design-focused documentation can remain in the repo, while the website serves as the user-facing overview.

understood, I can extend the official website to include the in-place updates section. I assume I just need to raise a PR against https://github.com/kubernetes/website

Yup. You probably need to update the vpa file I have created in kubernetes/website#53345

[iamzili]

FYI - I re-read the new VPA write-up and I'm proposing some small changes, along with a section about LimitRange resources: kubernetes/website#53395

@omerap12 I don't think there's a need to document the in-place update in more detail there. My personal opinion is that it already provides a good high-level description of the feature.