coreos / butane

Butane translates human-readable Butane Configs into machine-readable Ignition Configs.

https://coreos.github.io/butane/

Apache License 2.0

255 stars 70 forks source link

docs: add simple examples for SSH key & systemd file references (#179) #444

Closed Okeanos closed 1 year ago

Okeanos commented 1 year ago

Add minimal examples to the butane documentation explaining how to use file references instead of inlining SSH keys and systemd units introduced with #179 .

Noticed this was missing while working on coreos-docs#511.

bgilbert commented 1 year ago

Requires #442.

bgilbert commented 1 year ago

442 merged, so this can be rebased to fix CI.

Okeanos commented 1 year ago

Rebased and fixed the ./test execution with an additional test file declaration. If you want me to change that to use example.conf instead for example instead of introducing an additional file let me know.

The release notes obviously fail right now (because I see the changes as part of the #179 issue) but I can touch the file if you want me to.

Okeanos commented 1 year ago

I hopefully addressed your feedback now. If there's anything else you'd like adapted (or I overlooked) please let me know and I'll fix it.