Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/src/host-v1.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@
"type": "object",
"required": [
"checksum",
"deploySerial"
"deploySerial",
"stateroot"
],
"properties": {
"checksum": {
Expand All @@ -131,6 +132,10 @@
"type": "integer",
"format": "uint32",
"minimum": 0.0
},
"stateroot": {
"description": "The name of the storage for /etc and /var content",
"type": "string"
}
}
},
Expand Down Expand Up @@ -194,6 +199,13 @@
}
]
},
"otherDeployments": {
"description": "Other deployments (i.e. pinned)",
"type": "array",
"items": {
"$ref": "#/definitions/BootEntry"
}
},
"rollback": {
"description": "The previously booted image",
"anyOf": [
Expand Down Expand Up @@ -311,10 +323,15 @@
"description": "The status of the booted image",
"type": "object",
"required": [
"architecture",
"image",
"imageDigest"
],
"properties": {
"architecture": {
"description": "The hardware architecture of this image",
"type": "string"
},
"image": {
"description": "The currently booted image",
"allOf": [
Expand Down
15 changes: 11 additions & 4 deletions docs/src/man/bootc-container-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ checks as part of a container build
# SYNOPSIS

**bootc container lint** \[**\--rootfs**\] \[**\--fatal-warnings**\]
\[**\--list**\] \[**\--skip**\] \[**-h**\|**\--help**\]
\[**\--list**\] \[**\--skip**\] \[**\--no-truncate**\]
\[**-h**\|**\--help**\]

# DESCRIPTION

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

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

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

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

**\--no-truncate**

: Don\'t truncate the output. By default, only a limited number of
entries are shown for each lint, followed by a count of remaining
entries

**-h**, **\--help**

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

# VERSION

v1.1.6
v1.4.0
2 changes: 1 addition & 1 deletion docs/src/man/bootc-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ bootc-container-help(8)

# VERSION

v1.1.6
v1.4.0
6 changes: 3 additions & 3 deletions docs/src/man/bootc-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Only changes to the \`spec\` section are honored.

**\--quiet**

: Dont display progress
: Don\'t display progress

**-h**, **\--help**

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

# VERSION

v1.1.6
v1.4.0
4 changes: 2 additions & 2 deletions docs/src/man/bootc-install-ensure-completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ your code is using \`bootc install to-filesystem\` from the start.

**-h**, **\--help**

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

# VERSION

v1.1.6
v1.4.0
2 changes: 1 addition & 1 deletion docs/src/man/bootc-install-finalize.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ to-filesystem\`

# VERSION

v1.1.6
v1.4.0
4 changes: 2 additions & 2 deletions docs/src/man/bootc-install-print-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ string-valued filesystem name suitable for passing to \`mkfs.\$type\`.

**-h**, **\--help**

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

# VERSION

v1.1.6
v1.4.0
32 changes: 16 additions & 16 deletions docs/src/man/bootc-install-to-disk.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ bootc-install-to-disk - Install to the target block device
**bootc install to-disk** \[**\--wipe**\] \[**\--block-setup**\]
\[**\--filesystem**\] \[**\--root-size**\] \[**\--source-imgref**\]
\[**\--target-transport**\] \[**\--target-imgref**\]
\[**\--enforce-container-sigpolicy**\]
\[**\--skip-fetch-check**\] \[**\--run-fetch-check**\]
\[**\--disable-selinux**\] \[**\--karg**\]
\[**\--enforce-container-sigpolicy**\] \[**\--run-fetch-check**\]
\[**\--skip-fetch-check**\] \[**\--disable-selinux**\] \[**\--karg**\]
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
\[**\--bound-images**\] \[**\--stateroot**\] \[**\--via-loopback**\]
\[**-h**\|**\--help**\] \<*DEVICE*\>
Expand Down Expand Up @@ -63,8 +62,8 @@ more complex such as RAID, LVM, LUKS etc.

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

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

**\--skip-fetch-check (deprecated, see --run-fetch-check)**
**\--run-fetch-check**

: This is now the default and has no effect.
: Verify the image can be fetched from the bootc image. Updates may
fail when the installation host is authenticated with the registry
but the pull secret is not in the bootc image
Comment on lines +86 to +90

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The descriptions for --run-fetch-check and --skip-fetch-check are identical, which is confusing. The description for --skip-fetch-check should indicate that it disables verification.


**\--run-fetch-check **
**\--skip-fetch-check**

: Verify the target image can be pulled using the bootc image.

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

**\--disable-selinux**

Expand Down Expand Up @@ -135,11 +135,11 @@ more complex such as RAID, LVM, LUKS etc.
\
*Possible values:*

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

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

**\--stateroot**=*STATEROOT*

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

**-h**, **\--help**

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

\<*DEVICE*\>

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

# VERSION

v1.1.6
v1.4.0
45 changes: 26 additions & 19 deletions docs/src/man/bootc-install-to-existing-root.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,22 @@ bootc-install-to-existing-root - Install to the host root filesystem
**bootc install to-existing-root** \[**\--replace**\]
\[**\--source-imgref**\] \[**\--target-transport**\]
\[**\--target-imgref**\] \[**\--enforce-container-sigpolicy**\]
\[**\--skip-fetch-check**\] \[**\--run-fetch-check**\]
\[**\--run-fetch-check**\] \[**\--skip-fetch-check**\]
\[**\--disable-selinux**\] \[**\--karg**\]
\[**\--root-ssh-authorized-keys**\] \[**\--generic-image**\]
\[**\--bound-images**\] \[**\--stateroot**\]
\[**\--acknowledge-destructive**\] \[**-h**\|**\--help**\]
\[*ROOT_PATH*\]
\[**\--acknowledge-destructive**\] \[**\--cleanup**\]
\[**-h**\|**\--help**\] \[*ROOT_PATH*\]

# DESCRIPTION

Install to the host root filesystem.

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

# OPTIONS

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

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

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

**\--skip-fetch-check (deprecated, see --run-fetch-check)**

: This is now the default and has no effect.

**\--run-fetch-check**

: Verify the target image can be pulled using the bootc image.
: Verify the image can be fetched from the bootc image. Updates may
fail when the installation host is authenticated with the registry
but the pull secret is not in the bootc image
Comment on lines 72 to +76

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The descriptions for --run-fetch-check and --skip-fetch-check are identical, which is confusing. The description for --skip-fetch-check should indicate that it disables verification.


**\--skip-fetch-check**

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

**\--disable-selinux**

Expand Down Expand Up @@ -119,11 +121,11 @@ cleaned up if desired when rebooted into the new root.
\
*Possible values:*

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

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

**\--stateroot**=*STATEROOT*

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

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

**\--cleanup**

: Add the bootc-destructive-cleanup systemd service to delete files
from the previous install on first boot

**-h**, **\--help**

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

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

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

# VERSION

v1.1.6
v1.4.0
Loading