The recipe.yaml idea
#695
Open
opened 2026-10-19 08:47:16 +00:00 by decentral1se
·
4 comments
Labels
Clear labels
abra
awaiting-feedback
backups
bug
build
ci/cd
community organising
contributing
coopcloud.tech
design
documentation
duplicate
enhancement
fedi
fedi-infra
finance
funding
good first issue
help wanted
installer
legal
performance
proposal
question
security
test
wontfix
Everything to do with abra
Ping/pong on comms
Something is not working
Go build related issues
Getting the robots into the mix
Opening this thing up
Contributors stuff
Our main website
Design thinking required
Let's write things together
This issue or pull request already exists
New feature
Democratic decision making
Money things
Anything related to grant funding
Easy start with development
Need some help
Installation related issues
Performance related
Large change which requires feedback & decisin making
More information is needed
Securing our shit
Unit or integration test suite
This won't be fixed
No labels
enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
3wordchant
aadil (Aadil Ayub)
abra-bot (Abra Bot)
ammaratef45
amras (Sarma)
Apfelwurm
BornDeleuze (Born Deleuze)
Brooke
carla
cas (Cassowary)
coopcloud
cyrnel
dannygroenewegen (Danny Groenewegen)
decentral1se (d1)
dede
devydave
fauno (fauno)
hex (Josh Dukes)
iexos
jade (Jade Ambrose)
jjsfunhouse
jmakdah2 (Jackie Makdah)
joe-irving (Joe Irving)
kawaiipunk (KawaiiPunk)
knoflook
kolaente
lambdabundesverband
linnealovespie (April)
moosemower
moritz
notplants
oxaliq (sorrel)
p4u1 (p4u1)
pharaohgraphy (Andrew 🐦🔥❤️🔥✴️)
renovate-bot (Comrade Renovate Bot)
ripclap
simon
sixsmith (Sixsmith)
stevensting (stevensting)
trav (Trav Fryer)
val (val (he/him))
yksflip
Clear assignees
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: toolshed/organising#695
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Follows coop-cloud/traefik#145 from @p4u1.
What are the other benefits we see in a
recipe.yaml? And to be clear, I believe.envbackwards compatibility must be maintained. Do people have CLI UI/UX proposals also?toolshed/abra#504
i think
.envis great for simplicity ("variable=value") while editing a yaml file needs the operator to know its edge cases (trueis different than "true", etc), format is more complex for new operators, and parsing errors are confusing...but i do think it's great to have a
recipe.ymlthat describes and documents the env vars, aimed at maintainers. this is what i was thinking for toolshed/abra#958 where abra constructs a.envfile for the operator to read. i think we also talked a while ago about being able to describe dependencies between env vars on such a file.i miss array/list and hash/object/struct support on templates sometimes, for instance at coop-cloud/garage#5
regarding simplicity of .envs - just an example for providing envs either as oneliner or via a yaml dictionary:
https://git.local-it.org/local-it/kolli-config/src/commit/03de6a956bc6ca524cfadbb5efe6a4605de18f73/config-sets.yml#L98-L108
see
APP_ICONSvsEXTRA_ICONSAh, I didn't get it yet that the
recipe.ymlwould only be for maintainers. That is a very nice way of looking at it actually. Then operators continue to work with.envfiles?I would hope the
.ymlcould retain all the optional comments / boilerplate / etc. and we could rip that out of the default.env.sample? It would be nice if new operators were only confronted with a minimal env with required vars and could gradually include more env var config as needed via docs and workflow usingabra?Does someone have a proposal for how the
recipe.ymlshould look like and work? Howabrashould interact with it? I've been enjoying how the Reticulum command-line toolrnsdhas an--exampleconfigoption which spits out the entire config which is heavily documented and then you can pick and choose what you need.