Skip to content

Commit

Permalink
blueprint-reference: describe new kickstart customization
Browse files Browse the repository at this point in the history
Describe the new installer.kickstart customization that allows users to
inject their own custom kickstart content into an ISO build.
See osbuild/osbuild-composer#4135
  • Loading branch information
achilleas-k authored and ondrejbudai committed Jul 2, 2024
1 parent c869d38 commit eef82ba
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/user-guide/01-blueprint-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1360,6 +1360,46 @@ restorecon -rvF /etc/sudoers.d
%end
```

#### Installer Kickstart 🔵 🟤 {#installer-kickstart}

Alternatively, a custom kickstart can be included using the following customization.
<Tabs values={tabValues} >
<TabItem value="on-premises" >
```toml
[customizations.installer.kickstart]
contents = """
text --non-interactive
zerombr
clearpart --all --initlabel --disklabel=gpt
autopart --noswap --type=lvm
network --bootproto=dhcp --device=link --activate --onboot=on
"""
```
</TabItem>
<TabItem value="hosted" >
```json
{
"customizations": {
"installer": {
"kickstart": {
"contents": "text --non-interactive\nzerombr\nclearpart --all --initlabel --disklabel=gpt\nautopart --noswap --type=lvm\nnetwork --bootproto=dhcp --device=link --activate --onboot=on"
}
}
}
}
```
</TabItem>
<TabItem value="bootc" >
```
ℹ️ - Currently not supported
```
</TabItem>
</Tabs>

Note that osbuild-composer will automatically add the command that installs the system (`liveimg` or `ostreesetup`) if one is relevant for the image type (`image-installer` and `edge-installer`/`iot-installer` respectively), so this line or any line that conflicts with it should not be included. See the relevant [Kickstart documentation](https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html#ostreecontainer) for more information.
This customization cannot be used in combination with any other installer customizations.


## Example Blueprints

### Multiple customizations
Expand Down

0 comments on commit eef82ba

Please sign in to comment.