Skip to content

Commit d859620

Browse files
committed
Automated developer guide update
1 parent 2dd719d commit d859620

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

docs/bootc/index.md

+32
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,38 @@ Example:
332332

333333
```
334334

335+
### Anaconda ISO (installer) options (`installer`, mapping)
336+
337+
Users can include kickstart file content that will be added to an ISO build to configure the installation process.
338+
Since multi-line strings are difficult to write and read in json, it's easier to use the toml format when adding kickstart contents:
339+
340+
```toml
341+
[customizations.installer.kickstart]
342+
contents = """
343+
text --non-interactive
344+
zerombr
345+
clearpart --all --initlabel --disklabel=gpt
346+
autopart --noswap --type=lvm
347+
network --bootproto=dhcp --device=link --activate --onboot=on
348+
"""
349+
```
350+
351+
The equivalent in json would be:
352+
```json
353+
{
354+
"customizations": {
355+
"installer": {
356+
"kickstart": {
357+
"contents": "text --non-interactive\nzerombr\nclearpart --all --initlabel --disklabel=gpt\nautopart --noswap --type=lvm\nnetwork --bootproto=dhcp --device=link --activate --onboot=on"
358+
}
359+
}
360+
}
361+
}
362+
```
363+
364+
Note that bootc-image-builder will automatically add the command that installs the container image (`ostreecontainer ...`), 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.
365+
No other kickstart commands are added by bootc-image-builder in this case, so it is the responsibility of the user to provide all other commands (for example, for partitioning, network, language, etc).
366+
335367
## Building
336368

337369
To build the container locally you can run
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
2+
# org.osbuild.dmverity
3+
4+
**Enables dm-verity protection**
5+
6+
Sets up dm-verity for data_device and stores hash blockes on hash_device.
7+
Root hash gets written to `root_hash_file`
8+
9+
## Schema 1
10+
11+
```json
12+
{}
13+
```
14+
15+
## Schema 2
16+
17+
```json
18+
{
19+
"options": {
20+
"additionalProperties": false,
21+
"required": [
22+
"root_hash_file"
23+
],
24+
"properties": {
25+
"blocksize": {
26+
"type": "number",
27+
"default": 512
28+
},
29+
"root_hash_file": {
30+
"type": "string"
31+
}
32+
}
33+
},
34+
"devices": {
35+
"type": "object",
36+
"additionalProperties": true,
37+
"required": [
38+
"data_device",
39+
"hash_device"
40+
],
41+
"properties": {
42+
"data_device": {
43+
"type": "object",
44+
"additionalProperties": false,
45+
"required": [
46+
"path"
47+
],
48+
"properties": {
49+
"path": {
50+
"type": "string"
51+
}
52+
}
53+
},
54+
"hash_device": {
55+
"type": "object",
56+
"additionalProperties": false,
57+
"required": [
58+
"path"
59+
],
60+
"properties": {
61+
"path": {
62+
"type": "string"
63+
}
64+
}
65+
}
66+
}
67+
}
68+
}
69+
```

0 commit comments

Comments
 (0)