Skip to content

Commit

Permalink
docs: Add a "Creating derived configs" section
Browse files Browse the repository at this point in the history
  • Loading branch information
cgwalters committed Jul 27, 2021
1 parent 6ff2b19 commit 197d23d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,51 @@ systemd:
WantedBy=multi-user.target
```

### Creating derived configs

A common scenario will be to have a "base" Ignition config, and then
you want to create machine-specific versions that e.g. contain
static IP addressing or a static `/etc/hostname`, etc.

Another common scenario is to have a pool of bare metal machines
where some have e.g. SATA disks, other newer machines have NVMe
drives, etc.

In the following, the `base.ign` is an Ignition config file you
have locally. It could be generated via whatever mechanism you prefer (could also be butane, or not).
These examples just change the value of `/etc/hostname`, but everything
above (storage configuration etc.) can be added too.

<!-- butane-config -->
```yaml
variant: fcos
version: 1.1.0
ignition:
config:
merge:
- local: base.ign
storage:
files:
- path: /etc/hostname
contents:
inline: foo.example.com
```

<!-- butane-config -->
```yaml
variant: fcos
version: 1.1.0
ignition:
config:
merge:
- local: base.ign
storage:
files:
- path: /etc/hostname
contents:
inline: bar.example.com
```

[spec]: specs.md
[dropins]: https://www.freedesktop.org/software/systemd/man/systemd.unit.html#Description
[fcos-auth-docs]: https://docs.fedoraproject.org/en-US/fedora-coreos/authentication
1 change: 1 addition & 0 deletions test
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ trap 'rm -r tmpdocs' EXIT
# Create files-dir contents expected by configs
mkdir -p tmpdocs/files-dir/tree
touch tmpdocs/files-dir/{config.ign,ca.pem,file,file-epilogue,local-file3}
ln -sr tmpdocs/files-dir/{config,base}.ign

for doc in docs/*md
do
Expand Down

0 comments on commit 197d23d

Please sign in to comment.