search

eksctl-io / eksctl

The official CLI for Amazon EKS
https://eksctl.io
Other
4.94k stars 1.42k forks source link

[Feedback] Config File Schema - /usage/schema/ #7998

Open DariusX opened 1 month ago

DariusX commented 1 month ago

The schema page does not drill down enough. Ideally, it would provide the entire schema down to the last detail, and would also mention default behavior. The Kubernetes API reference is a good example. Is there a detailed reference like that for eksctl ?

github-actions[bot] commented 1 month ago

Hello DariusX :wave: Thank you for opening an issue in eksctl project. The team will review the issue and aim to respond within 1-5 business days. Meanwhile, please read about the Contribution and Code of Conduct guidelines here. You can find out more information about eksctl on our website

cPu1 commented 1 month ago

The examples directory contains examples of common usage but that's all we have other than the docs. Our docs could use some improvements but it will take some time.

DariusX commented 1 month ago

Thanks @cPu1 Is there a particular place in the code that a developer could look at, in order to get a definitive picture of what is allowed in a config.yaml file passed to eksctl?

cPu1 commented 1 month ago

Thanks @cPu1 Is there a particular place in the code that a developer could look at, in order to get a definitive picture of what is allowed in a config.yaml file passed to eksctl?

Yes. This is a good starting point: https://github.com/eksctl-io/eksctl/blob/main/pkg/apis/eksctl.io/v1alpha5/types.go#L884.

github-actions[bot] commented 4 days ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.