aws / aws/containers-roadmap

[EKS] [AddOn configuration values documentation]: web documentation for the configuration values for AddOns

Open
#2,147 0 comments 38 reactions 0 assignees View on GitHub
Docs 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 can find the configuration schema an EKS AddOn as follows:
```
$ aws eks describe-addon-configuration --addon-name aws-ebs-csi-driver --addon-version v1.21.0-eksbuild.1 --query configurationSchema --output text | jq .
```
This gives me some JSON Schema that describes the configuration values I can pass to an addon.

This does give me all the information, but in a way that is extremely hard to parse as a human.

AWS should host this in a human readable format. By comparison, see the table on https://artifacthub.io/packages/helm/aws/aws-cloudwatch-metrics

**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?**
Reading JSON Schema to determine how to configure an addon is hard. Reading it on a web page would be better.

**Are you currently working around this issue?**
Reading JSON Schema from `aws eks describe-addon-configuration`.

Contributor guide

Open the contributing guide

Research direction

The request names the EKS AddOn configuration schema returned by `aws eks describe-addon-configuration` and compares it with the linked Artifact Hub presentation. Start by reviewing that command's `configurationSchema` output and the referenced web table. Done means AWS provides the AddOn configuration values in a human-readable web format.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.