Defined Standards & Best Practices for Packs

[hashicorp]

Defined Standards & Best Practices for Packs

[mikenomitch]

Absolutely agree that something like this would be great.

This is something that we've been discussing internally. Some of the best practices might come through in documentation, some might be added with an init command that creates helper templates for you, some might take the form of shared templates from dependent packs, and some things might be templates built into the tool itself. We're still figuring out the details. If any of those sound particularly better/worse than the other, let us know. :)

There should be some more movement on this soon.

[efbar]

Hi, my two cents!
I agree with everything you've both said. I would add a vars.nomad example file (a file with the variables that could be used within the pack) as almost "mandatory" in every pack. It could be created by the init command. I put it in Jenkins and InfluxDB PRs, I think that those are quite useful and they can also provide some explanation on how the app itself works.
It should be considered volume management also, and in particular when we have multiple volumes to mount. Some questions that come into my mind could be: which is the naming convention? How the preparation of the volume should be used? These things could be defined at least at docs level.

[tgross]

@mikenomitch another area we should probably document is licensing and source availability requirements for this registry. We've got an open PR (#55) where the application doesn't have a known source or license. (I'll probably have to close that PR if we don't get a reply back on that subject in the next little while.)