From 4c2d1e5b2ee0792b1a8ca3b330fd391c6bdb8285 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 1 Mar 2026 20:16:17 +0200 Subject: add README.md to each example directory with usage instructions --- examples/rake/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 examples/rake/README.md (limited to 'examples/rake') diff --git a/examples/rake/README.md b/examples/rake/README.md new file mode 100644 index 0000000..93a83ec --- /dev/null +++ b/examples/rake/README.md @@ -0,0 +1,29 @@ +# Example: With Rake + +Uses RCM from a Rake task with a `config.toml` for host group definitions. + +## Setup + +```sh +bundle install +``` + +## Usage + +```sh +# Dry run — show what would change, make no changes +rake setup -- --dry + +# Verbose output +rake setup -- --debug + +# Apply configuration +rake setup +``` + +## What it does + +- Creates `/tmp/example/wg/wg0.conf` from an inline ERB template (parent directory created automatically) +- Ensures the line `192.168.1.101 earth.local` is present in `/tmp/example/hosts.txt` + +Both operations only run when the current hostname is `earth`. -- cgit v1.2.3