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

Add new module template #164

Open
nabokihms opened this issue Jan 7, 2021 · 0 comments
Open

Add new module template #164

nabokihms opened this issue Jan 7, 2021 · 0 comments

Comments

@nabokihms
Copy link
Member

Is your feature request related to a problem? Please describe.
The main problem is that it is hard to develop a new module from scratch. Users need to know what they can add and how it changes module behavior.

Describe the solution you'd like to see
It would be convenient to have an example/template of a new module. For example, let's look at the helm create command. By calling it, a user creates a new folder with every file which has a special meaning (Chart.yaml, values.yaml, etc.). Each file contains a description of what you can change in it.
Personally, I don't think we need a command, a folder that you can copy to create a new module should be enough.

Files which should be included in the template:

  • README.md
  • enable.sh
  • hooks
  • templates
  • templates/openapi
  • values.yaml
  • .helmignore
  • Chart.yaml (?)

Describe alternatives you've considered
I think the only alternative for users is to read docs and learn what features the addon-operator has. This is hard for newcomers, though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant