eksctl icon indicating copy to clipboard operation
eksctl copied to clipboard

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

Open DariusX opened this issue 1 year ago • 4 comments

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 ?

DariusX avatar Oct 12 '24 10:10 DariusX

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

github-actions[bot] avatar Oct 12 '24 10:10 github-actions[bot]

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.

cPu1 avatar Oct 14 '24 09:10 cPu1

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?

DariusX avatar Oct 15 '24 10:10 DariusX

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.

cPu1 avatar Oct 21 '24 11:10 cPu1

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.

github-actions[bot] avatar Nov 21 '24 02:11 github-actions[bot]

This issue was closed because it has been stalled for 5 days with no activity.

github-actions[bot] avatar Nov 26 '24 02:11 github-actions[bot]