Skip to content

Commit

Permalink
docs: add distributor notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen Lowrie committed Mar 31, 2021
1 parent 5a1f829 commit bda6b72
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
nav_order: 9
nav_order: 10
---

# Development
Expand Down
18 changes: 18 additions & 0 deletions docs/distributor-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
nav_order: 8
---

# 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.

Distributors will also need to create a systemd unit in the initrd, the suggested ordering is after `ignition-fetch.service` and before `ignition-disks.service`.

An example of the binary implementation look at [`examples/ignition-kargs-helper`](https://github.com/coreos/ignition/blob/master/examples/ignition-kargs-helper) & an example service unit is avialable at [`dracut/30ignition/ignition-kargs.service`](https://github.com/coreos/ignition/blob/master/examples/ignition-kargs.service).
2 changes: 1 addition & 1 deletion docs/supported-platforms.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
nav_order: 8
nav_order: 9
---

# Supported Platforms
Expand Down

0 comments on commit bda6b72

Please sign in to comment.