docs/distributor-notes.md

---
nav_order: 10
---

# Distributor Notes
{: .no_toc}

1. TOC
{:toc}

## Dracut Module

The distribution specific integration is responsible for ensuring that the ignition dracut module is included in the initramfs when necessary. This can be achieved by adding it as dependency of the dracut module containing the distribution integration, or by installing a dracut configuration file.

## 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/main/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/main/dracut/30ignition/ignition-kargs.service) should be disabled.
docs: add distributor notes 2021-03-15 23:20:40 -05:00			`---`
NEWS: move to docs Since the release notes are in Markdown now, let's add them to the docs site. Add a symlink from the root to make them easier to find in a tarball or checkout. 2022-05-23 23:23:49 -04:00			`nav_order: 10`
docs: add distributor notes 2021-03-15 23:20:40 -05:00			`---`

			`# Distributor Notes`
			`{: .no_toc}`

			`1. TOC`
			`{:toc}`

dracut: Don't include the ignition module by default Currently the module is automatically included in all initrds, hostonly or generic. Leave it to the distro provided module to pull it in explicitly. 2023-08-21 14:17:01 +02:00			`## Dracut Module`

			`The distribution specific integration is responsible for ensuring that the ignition dracut module is included in the initramfs when necessary. This can be achieved by adding it as dependency of the dracut module containing the distribution integration, or by installing a dracut configuration file.`

docs: add distributor notes 2021-03-15 23:20:40 -05:00			`## 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.

*: rename master branch to main 2021-05-05 02:10:56 -04:00			As an example of the binary implementation look at [`examples/ignition-kargs-helper`](https://github.com/coreos/ignition/blob/main/examples/ignition-kargs-helper).
docs: add distributor notes 2021-03-15 23:20:40 -05:00
*: rename master branch to main 2021-05-05 02:10:56 -04:00			If your implementation of Ignition doesn't intend to ship kargs functionality the [`ignition-kargs.service` unit](https://github.com/coreos/ignition/blob/main/dracut/30ignition/ignition-kargs.service) should be disabled.