aws / aws/containers-roadmap

[eks] [request]: Improve Metrics Server documentation

Open
#1,767 0 comments 0 reactions 0 assignees View on GitHub
EKS EKS Add-Ons Proposed
Dominant language
Shell
Stars
5.4k
Forks
334
PR merge metrics
No merged PRs in 30d

Description

### Community Note

* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
* If you are interested in working on this issue or have submitted a pull request, please leave a comment

**Tell us about your request**
I'd like the EKS [Metrics Server documentation](https://docs.aws.amazon.com/eks/latest/userguide/metrics-server.html) (and other related documentation) to be updated to better show the possible installation options and to cover supporting the correct ports.

**Which service(s) is this request for?**
EKS

**Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard?**
The current EKS Metrics Server guide only shows the basic manifest installation from the `latest` release this is problematic for two reasons. Firstly that's a sliding tag which will get a new target each time Metrics Server is released, a new version of Metrics Server might not work with current EKS versions or might require changing other EKS documentation. Secondly there is now a [HA manifest](https://github.com/kubernetes-sigs/metrics-server/releases/download/v0.6.1/high-availability.yaml) and a [Helm Chart](https://artifacthub.io/packages/helm/metrics-server/metrics-server) which provide more installation options over the [default manifest](https://github.com/kubernetes-sigs/metrics-server/releases/download/v0.6.1/components.yaml).

In addition to this I think the [EKS SG requirements documentation](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) might be incorrect, and it's definitely missing the port required for Metrics Server. Metrics Server currently (see additional context for more details) requires that port `4443` is open between the control plane and the nodes and that port `10250` is open between the nodes. I suspect that the currently documented rule for `443` from cluster to node is a legacy from when Metrics Server used to use that port instead of `4443`?

**Are you currently working around this issue?**
Ignoring the EKS documentation and using the Helm chart to deploy HA Metrics Server using port 10250.

**Additional context**
The next Metrics Server release will change the default container port from `4443` to `10250` to make use of existing firewall rules (see https://github.com/kubernetes-sigs/metrics-server/pull/1054 for the change).

**Attachments**
n/a

Contributor guide

Open the contributing guide

Research direction

Start with the linked EKS Metrics Server and security-group requirements pages, then compare the v0.6.1 default and HA manifests with the Helm chart, including ports 4443 and 10250. Done means the related documentation names supported installation options, pins releases appropriately, and accurately documents the required control-plane/node and node/node connectivity.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, helm, kubernetes
Domain
cloud, documentation, networking
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.