containers / containers/appstore
More example quadlets
- Dominant language
- Python
- Stars
- 62
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
I have created a repository including dozens of quadlets that I would like to share with the wider community. It can be found on my Forgejo instance, running on my home server which I use to dogfood every quadlet in the repo. I have not created a readme for every quadlet yet, but I am actively seeking suggestions for improving the documentation of my project. Additionally, I am interested in creating a python tool to automate the installation and setup of quadlets from some central repository. At this time, I am not a very strong developer, but in theory the tool shouldn't be too complex so I'm excited to continue working on it. I also don't like the name, but everyone knows naming things is hard.
You can find my quadlet examples [here](https://git.mcgee.red/redbeardymcgee/podbox). This is also a push mirror to [github](https://github.com/redbeardymcgee/podbox), though I would now prefer to treat the GitHub as a second-class archive instead of the primary source.
Much of the work I've done recently is to normalize the quadlets such that users can copy the files to the correct directory and start them immediately, without having to fuss with a lot of specific configuration. This is why nearly every quadlet includes its own special copy of any database it requires instead of just 1 universal example for postgres, mariadb, mysql, etc. It is also the reason why so many include their own network unit, and why I have lifted almost all volume mounts into an associated volume unit. I am open to restructuring the examples, but I think normalizing all of them in the way I have provides additional value and ease of use.
Many are, of course, special case and do not follow the exact same structure. For example, I chose to include some `Network=container:gluetun` to demonstrate this possibility, but also because some of the services only make sense when routed through your chosen VPN. This would be an obvious candidate for better documentation, probably, but I'm still figuring out how to structure docs as well.
Is there some better place to discuss this further?
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the linked podbox repository and the appstore example structure first. Clarify whether the contribution is additional quadlet examples, documentation for existing examples, or a Python installer; define one scoped outcome and its acceptance criteria before coding. The issue does not name files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes, python
- Domain
- documentation, infrastructure
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100