diff --git a/docs/development.md b/docs/development.md index 9fefe80951..c311cb8abd 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,6 +1,6 @@ --- layout: default -nav_order: 9 +nav_order: 10 --- # Development diff --git a/docs/distributor-notes.md b/docs/distributor-notes.md new file mode 100644 index 0000000000..c978ec5e86 --- /dev/null +++ b/docs/distributor-notes.md @@ -0,0 +1,18 @@ +--- +layout: default +nav_order: 9 +--- + +# Distributor Notes +{: .no_toc} + +1. TOC +{:toc} + +## Kernel Arguments + +When Ignition is updating kernel arguments it will call out to a binary (defined in `internal/distro/distro.go` and overridable at build-time via overriding the `github.com/coreos/ignition/v2/internal/distro.kargsCmd` build flag). Ignition expects that the binary accepts `--should-exist` & `--should-not-exist` parameters. Should exist operations should append the argument if missing and should not exist should NOT fail if the argument is not present. The binary should also reboot the system if necessary. + +As an example of the binary implementation look at [`examples/ignition-kargs-helper`](https://github.com/coreos/ignition/blob/master/examples/ignition-kargs-helper). + +If your implementation of Ignition doesn't intend to ship kargs functionality the [`ignition-kargs.service` unit](https://github.com/coreos/ignition/blob/master/dracut/30ignition/ignition-kargs.service) should be disabled.