Skip to content

Commit 79cc6b4

Browse files
authored
Merge pull request #1385 from jeckersb/update-generated
docs: Update generated
2 parents 3c083cf + 1b3f141 commit 79cc6b4

18 files changed

+142
-84
lines changed

docs/src/host-v1.schema.json

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@
119119
"type": "object",
120120
"required": [
121121
"checksum",
122-
"deploySerial"
122+
"deploySerial",
123+
"stateroot"
123124
],
124125
"properties": {
125126
"checksum": {
@@ -131,6 +132,10 @@
131132
"type": "integer",
132133
"format": "uint32",
133134
"minimum": 0.0
135+
},
136+
"stateroot": {
137+
"description": "The name of the storage for /etc and /var content",
138+
"type": "string"
134139
}
135140
}
136141
},
@@ -194,6 +199,13 @@
194199
}
195200
]
196201
},
202+
"otherDeployments": {
203+
"description": "Other deployments (i.e. pinned)",
204+
"type": "array",
205+
"items": {
206+
"$ref": "#/definitions/BootEntry"
207+
}
208+
},
197209
"rollback": {
198210
"description": "The previously booted image",
199211
"anyOf": [
@@ -311,10 +323,15 @@
311323
"description": "The status of the booted image",
312324
"type": "object",
313325
"required": [
326+
"architecture",
314327
"image",
315328
"imageDigest"
316329
],
317330
"properties": {
331+
"architecture": {
332+
"description": "The hardware architecture of this image",
333+
"type": "string"
334+
},
318335
"image": {
319336
"description": "The currently booted image",
320337
"allOf": [

docs/src/man/bootc-container-lint.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ checks as part of a container build
66
# SYNOPSIS
77

88
**bootc container lint** \[**\--rootfs**\] \[**\--fatal-warnings**\]
9-
\[**\--list**\] \[**\--skip**\] \[**-h**\|**\--help**\]
9+
\[**\--list**\] \[**\--skip**\] \[**\--no-truncate**\]
10+
\[**-h**\|**\--help**\]
1011

1112
# DESCRIPTION
1213

@@ -29,7 +30,7 @@ part of a build process; it will error if any problems are detected.
2930
**\--list**
3031

3132
: Instead of executing the lints, just print all available lints. At
32-
the current time, this will output in YAML format because its
33+
the current time, this will output in YAML format because it\'s
3334
reasonably human friendly. However, there is no commitment to
3435
maintaining this exact format; do not parse it via code or scripts
3536

@@ -40,10 +41,16 @@ part of a build process; it will error if any problems are detected.
4041

4142
Example: \--skip nonempty-boot \--skip baseimage-root
4243

44+
**\--no-truncate**
45+
46+
: Don\'t truncate the output. By default, only a limited number of
47+
entries are shown for each lint, followed by a count of remaining
48+
entries
49+
4350
**-h**, **\--help**
4451

45-
: Print help (see a summary with -h)
52+
: Print help (see a summary with \'-h\')
4653

4754
# VERSION
4855

49-
v1.1.6
56+
v1.4.0

docs/src/man/bootc-container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ bootc-container-help(8)
3030

3131
# VERSION
3232

33-
v1.1.6
33+
v1.4.0

docs/src/man/bootc-edit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Only changes to the \`spec\` section are honored.
2828

2929
**\--quiet**
3030

31-
: Dont display progress
31+
: Don\'t display progress
3232

3333
**-h**, **\--help**
3434

35-
: Print help (see a summary with -h)
35+
: Print help (see a summary with \'-h\')
3636

3737
# VERSION
3838

39-
v1.1.6
39+
v1.4.0

docs/src/man/bootc-install-ensure-completion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ your code is using \`bootc install to-filesystem\` from the start.
2323

2424
**-h**, **\--help**
2525

26-
: Print help (see a summary with -h)
26+
: Print help (see a summary with \'-h\')
2727

2828
# VERSION
2929

30-
v1.1.6
30+
v1.4.0

docs/src/man/bootc-install-finalize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ to-filesystem\`
2424

2525
# VERSION
2626

27-
v1.1.6
27+
v1.4.0

docs/src/man/bootc-install-print-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`.
2323

2424
**-h**, **\--help**
2525

26-
: Print help (see a summary with -h)
26+
: Print help (see a summary with \'-h\')
2727

2828
# VERSION
2929

30-
v1.1.6
30+
v1.4.0

docs/src/man/bootc-install-to-disk.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ bootc-install-to-disk - Install to the target block device
77
**bootc install to-disk** \[**\--wipe**\] \[**\--block-setup**\]
88
\[**\--filesystem**\] \[**\--root-size**\] \[**\--source-imgref**\]
99
\[**\--target-transport**\] \[**\--target-imgref**\]
10-
\[**\--enforce-container-sigpolicy**\]
11-
\[**\--skip-fetch-check**\] \[**\--run-fetch-check**\]
12-
\[**\--disable-selinux**\] \[**\--karg**\]
10+
\[**\--enforce-container-sigpolicy**\] \[**\--run-fetch-check**\]
11+
\[**\--skip-fetch-check**\] \[**\--disable-selinux**\] \[**\--karg**\]
1312
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
1413
\[**\--bound-images**\] \[**\--stateroot**\] \[**\--via-loopback**\]
1514
\[**-h**\|**\--help**\] \<*DEVICE*\>
@@ -63,8 +62,8 @@ more complex such as RAID, LVM, LUKS etc.
6362

6463
By default, bootc install and install-to-filesystem assumes that it
6564
runs in a podman container, and it takes the container image to
66-
install from the podmans container registry. If \--source-imgref is
67-
given, bootc uses it as the installation source, instead of the
65+
install from the podman\'s container registry. If \--source-imgref
66+
is given, bootc uses it as the installation source, instead of the
6867
behaviour explained in the previous paragraph. See skopeo(1) for
6968
accepted formats.
7069

@@ -84,16 +83,17 @@ more complex such as RAID, LVM, LUKS etc.
8483
Enabling this option enforces that \`/etc/containers/policy.json\`
8584
includes a default policy which requires signatures
8685

87-
**\--skip-fetch-check (deprecated, see --run-fetch-check)**
86+
**\--run-fetch-check**
8887

89-
: This is now the default and has no effect.
88+
: Verify the image can be fetched from the bootc image. Updates may
89+
fail when the installation host is authenticated with the registry
90+
but the pull secret is not in the bootc image
9091

91-
**\--run-fetch-check **
92+
**\--skip-fetch-check**
9293

93-
: Verify the target image can be pulled using the bootc image.
94-
95-
This will ensure the bootc system can be upgraded,
96-
i.e. the registry credentials are available on the bootc image.
94+
: Verify the image can be fetched from the bootc image. Updates may
95+
fail when the installation host is authenticated with the registry
96+
but the pull secret is not in the bootc image
9797

9898
**\--disable-selinux**
9999

@@ -135,11 +135,11 @@ more complex such as RAID, LVM, LUKS etc.
135135
\
136136
*Possible values:*
137137

138-
- stored: Bound images must exist in the sources root container
138+
- stored: Bound images must exist in the source\'s root container
139139
storage (default)
140140

141141
- pull: Bound images will be pulled and stored directly in the
142-
targets bootc container storage
142+
target\'s bootc container storage
143143

144144
**\--stateroot**=*STATEROOT*
145145

@@ -151,7 +151,7 @@ more complex such as RAID, LVM, LUKS etc.
151151

152152
**-h**, **\--help**
153153

154-
: Print help (see a summary with -h)
154+
: Print help (see a summary with \'-h\')
155155

156156
\<*DEVICE*\>
157157

@@ -160,4 +160,4 @@ more complex such as RAID, LVM, LUKS etc.
160160

161161
# VERSION
162162

163-
v1.1.6
163+
v1.4.0

docs/src/man/bootc-install-to-existing-root.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,22 @@ bootc-install-to-existing-root - Install to the host root filesystem
77
**bootc install to-existing-root** \[**\--replace**\]
88
\[**\--source-imgref**\] \[**\--target-transport**\]
99
\[**\--target-imgref**\] \[**\--enforce-container-sigpolicy**\]
10-
\[**\--skip-fetch-check**\] \[**\--run-fetch-check**\]
10+
\[**\--run-fetch-check**\] \[**\--skip-fetch-check**\]
11+
\[**\--disable-selinux**\] \[**\--karg**\]
1112
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
1213
\[**\--bound-images**\] \[**\--stateroot**\]
13-
\[**\--acknowledge-destructive**\] \[**-h**\|**\--help**\]
14-
\[*ROOT_PATH*\]
14+
\[**\--acknowledge-destructive**\] \[**\--cleanup**\]
15+
\[**-h**\|**\--help**\] \[*ROOT_PATH*\]
1516

1617
# DESCRIPTION
1718

1819
Install to the host root filesystem.
1920

2021
This is a variant of \`install to-filesystem\` that is designed to
2122
install \"alongside\" the running host root filesystem. Currently, the
22-
host root filesystems \`/boot\` partition will be wiped, but the content
23-
of the existing root will otherwise be retained, and will need to be
24-
cleaned up if desired when rebooted into the new root.
23+
host root filesystem\'s \`/boot\` partition will be wiped, but the
24+
content of the existing root will otherwise be retained, and will need
25+
to be cleaned up if desired when rebooted into the new root.
2526

2627
# OPTIONS
2728

@@ -47,8 +48,8 @@ cleaned up if desired when rebooted into the new root.
4748

4849
By default, bootc install and install-to-filesystem assumes that it
4950
runs in a podman container, and it takes the container image to
50-
install from the podmans container registry. If \--source-imgref is
51-
given, bootc uses it as the installation source, instead of the
51+
install from the podman\'s container registry. If \--source-imgref
52+
is given, bootc uses it as the installation source, instead of the
5253
behaviour explained in the previous paragraph. See skopeo(1) for
5354
accepted formats.
5455

@@ -68,16 +69,17 @@ cleaned up if desired when rebooted into the new root.
6869
Enabling this option enforces that \`/etc/containers/policy.json\`
6970
includes a default policy which requires signatures
7071

71-
**\--skip-fetch-check (deprecated, see --run-fetch-check)**
72-
73-
: This is now the default and has no effect.
74-
7572
**\--run-fetch-check**
7673

77-
: Verify the target image can be pulled using the bootc image.
74+
: Verify the image can be fetched from the bootc image. Updates may
75+
fail when the installation host is authenticated with the registry
76+
but the pull secret is not in the bootc image
77+
78+
**\--skip-fetch-check**
7879

79-
This will ensure the bootc system can be upgraded,
80-
i.e. the registry credentials are available on the bootc image.
80+
: Verify the image can be fetched from the bootc image. Updates may
81+
fail when the installation host is authenticated with the registry
82+
but the pull secret is not in the bootc image
8183

8284
**\--disable-selinux**
8385

@@ -119,11 +121,11 @@ cleaned up if desired when rebooted into the new root.
119121
\
120122
*Possible values:*
121123

122-
- stored: Bound images must exist in the sources root container
124+
- stored: Bound images must exist in the source\'s root container
123125
storage (default)
124126

125127
- pull: Bound images will be pulled and stored directly in the
126-
targets bootc container storage
128+
target\'s bootc container storage
127129

128130
**\--stateroot**=*STATEROOT*
129131

@@ -133,9 +135,14 @@ cleaned up if desired when rebooted into the new root.
133135

134136
: Accept that this is a destructive action and skip a warning timer
135137

138+
**\--cleanup**
139+
140+
: Add the bootc-destructive-cleanup systemd service to delete files
141+
from the previous install on first boot
142+
136143
**-h**, **\--help**
137144

138-
: Print help (see a summary with -h)
145+
: Print help (see a summary with \'-h\')
139146

140147
\[*ROOT_PATH*\] \[default: /target\]
141148

@@ -145,4 +152,4 @@ cleaned up if desired when rebooted into the new root.
145152

146153
# VERSION
147154

148-
v1.1.6
155+
v1.4.0

0 commit comments

Comments
 (0)