Skip to content

Commit 9964764

Browse files
committed
Automated developer guide update
1 parent 95b3914 commit 9964764

401 files changed

Lines changed: 904 additions & 796 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.createaddrsize.meta.json
3+
---
4+
# org.osbuild.createaddrsize
5+
<!--
6+
[//]: # ( DO NOT MODIFY THIS FILE! )
7+
[//]: # ( This content is generated by `scripts/pull_osbuild_modules.py` )
8+
[//]: # ( Rather change the source of this: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.createaddrsize.meta.json )
9+
-->
10+
11+
**Create the inird.addrsize file required for s390x iso booting**
12+
13+
Use the size of the initrd.img to create the addrsize file
14+
15+
## Schema 1
16+
17+
```json
18+
{}
19+
```
20+
21+
## Schema 2
22+
23+
```json
24+
{
25+
"options": {
26+
"additionalProperties": false,
27+
"required": [
28+
"initrd",
29+
"addrsize"
30+
],
31+
"properties": {
32+
"initrd": {
33+
"description": "Path to initramfs file",
34+
"type": "string",
35+
"pattern": "^\\/?(?!\\.\\.)((?!\\/\\.\\.\\/).)+$"
36+
},
37+
"addrsize": {
38+
"description": "Path of addrsize file to write",
39+
"type": "string",
40+
"pattern": "^\\/?(?!\\.\\.)((?!\\/\\.\\.\\/).)+$"
41+
}
42+
}
43+
}
44+
}
45+
```
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
custom_edit_url: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mks390image.meta.json
3+
---
4+
# org.osbuild.mks390image
5+
<!--
6+
[//]: # ( DO NOT MODIFY THIS FILE! )
7+
[//]: # ( This content is generated by `scripts/pull_osbuild_modules.py` )
8+
[//]: # ( Rather change the source of this: https://github.com/osbuild/osbuild/tree/main/stages/org.osbuild.mks390image.meta.json )
9+
-->
10+
11+
**Create an s390 bootable image with mk-s390image(1)**
12+
13+
Create a bootable image using the kernel, initrd, and prm config files
14+
Buildhost commands used: `mk-s390image`.
15+
16+
## Schema 1
17+
18+
```json
19+
{}
20+
```
21+
22+
## Schema 2
23+
24+
```json
25+
{
26+
"options": {
27+
"additionalProperties": false,
28+
"required": [
29+
"kernel",
30+
"initrd",
31+
"config",
32+
"image"
33+
],
34+
"properties": {
35+
"kernel": {
36+
"description": "Path to linux kernel",
37+
"type": "string",
38+
"pattern": "^\\/?(?!\\.\\.)((?!\\/\\.\\.\\/).)+$"
39+
},
40+
"initrd": {
41+
"description": "Path to initramfs file",
42+
"type": "string",
43+
"pattern": "^\\/?(?!\\.\\.)((?!\\/\\.\\.\\/).)+$"
44+
},
45+
"config": {
46+
"description": "Path to prm config file",
47+
"type": "string",
48+
"pattern": "^\\/?(?!\\.\\.)((?!\\/\\.\\.\\/).)+$"
49+
},
50+
"image": {
51+
"description": "Path of bootable image file to write",
52+
"type": "string",
53+
"pattern": "^\\/?(?!\\.\\.)((?!\\/\\.\\.\\/).)+$"
54+
}
55+
}
56+
}
57+
}
58+
```

docs/developer-guide/02-projects/osbuild/modules/stages/org.osbuild.xorrisofs.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@ required.
8181
"catalog": {
8282
"type": "string",
8383
"description": "Path to the boot catalog file (on the iso)"
84+
},
85+
"nobootinfo": {
86+
"type": "boolean",
87+
"default": false,
88+
"description": "Do not add -boot-info-table and -grub2-boot-info arguments"
8489
}
8590
}
8691
},

docs/user-guide/09-image-descriptions/00-rhel-10.1/ami.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **ami** on **Red Hat Enterprise Linux 10.1**.
@@ -325,4 +325,4 @@ blueprint:
325325
---
326326
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
327327

328-
*Last updated on: 2026-03-17 07:58:15 UTC*
328+
*Last updated on: 2026-03-18 07:57:55 UTC*

docs/user-guide/09-image-descriptions/00-rhel-10.1/azure-cvm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **azure-cvm** on **Red Hat Enterprise Linux 10.1**.
@@ -204,4 +204,4 @@ blueprint:
204204
---
205205
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
206206

207-
*Last updated on: 2026-03-17 07:58:15 UTC*
207+
*Last updated on: 2026-03-18 07:57:55 UTC*

docs/user-guide/09-image-descriptions/00-rhel-10.1/azure-rhui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **azure-rhui** on **Red Hat Enterprise Linux 10.1**.
@@ -454,4 +454,4 @@ blueprint:
454454
---
455455
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
456456

457-
*Last updated on: 2026-03-17 07:58:15 UTC*
457+
*Last updated on: 2026-03-18 07:57:55 UTC*

docs/user-guide/09-image-descriptions/00-rhel-10.1/azure-sap-rhui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **azure-sap-rhui** on **Red Hat Enterprise Linux 10.1**.
@@ -267,4 +267,4 @@ blueprint:
267267
---
268268
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
269269

270-
*Last updated on: 2026-03-17 07:58:15 UTC*
270+
*Last updated on: 2026-03-18 07:57:55 UTC*

docs/user-guide/09-image-descriptions/00-rhel-10.1/azure-sapapps-rhui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **azure-sapapps-rhui** on **Red Hat Enterprise Linux 10.1**.
@@ -264,4 +264,4 @@ blueprint:
264264
---
265265
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
266266

267-
*Last updated on: 2026-03-17 07:58:15 UTC*
267+
*Last updated on: 2026-03-18 07:57:55 UTC*

docs/user-guide/09-image-descriptions/00-rhel-10.1/ec2-cvm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **ec2-cvm** on **Red Hat Enterprise Linux 10.1**.
@@ -184,4 +184,4 @@ blueprint:
184184
---
185185
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
186186

187-
*Last updated on: 2026-03-17 07:58:15 UTC*
187+
*Last updated on: 2026-03-18 07:57:55 UTC*

docs/user-guide/09-image-descriptions/00-rhel-10.1/ec2-ha.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/osbuild/osbuild.github.io/blob/main/scripts/
77
<!--
88
[//]: # ( DO NOT MODIFY THIS FILE! )
99
[//]: # ( This content is generated by `scripts/pull_image_descriptions.py` )
10-
[//]: # ( Generated on: 2026-03-17 07:58:15 UTC )
10+
[//]: # ( Generated on: 2026-03-18 07:57:55 UTC )
1111
-->
1212

1313
Image description for **ec2-ha** on **Red Hat Enterprise Linux 10.1**.
@@ -183,4 +183,4 @@ blueprint:
183183
---
184184
*Generated using: `ghcr.io/osbuild/image-builder-cli:latest@sha256:e59f0077de7c5aed5cd9e581d72fe6d8bbe913e9a3202f70891b363c9c90eb79`*
185185

186-
*Last updated on: 2026-03-17 07:58:15 UTC*
186+
*Last updated on: 2026-03-18 07:57:55 UTC*

0 commit comments

Comments
 (0)