Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
DariusX opened this issue Oct 12, 2024 · 5 comments
Open

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

DariusX opened this issue Oct 12, 2024 · 5 comments
Labels
kind/docs User documentation stale

Comments

@DariusX
Copy link

DariusX commented Oct 12, 2024

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 ?

Copy link
Contributor

Hello DariusX 👋 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
Copy link
Collaborator

cPu1 commented Oct 14, 2024

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 cPu1 added the kind/docs User documentation label Oct 14, 2024
@DariusX
Copy link
Author

DariusX commented Oct 15, 2024

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
Copy link
Collaborator

cPu1 commented Oct 21, 2024

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.

Copy link
Contributor

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 github-actions bot added the stale label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs User documentation stale
Projects
None yet
Development

No branches or pull requests

2 participants