1
0
mirror of https://github.com/containers/bootc.git synced 2026-02-05 15:45:53 +01:00
Commit Graph

252 Commits

Author SHA1 Message Date
Colin Walters
99123ba27c docs: Document finding deployments in install-to-existing-root
Users doing `bootc install to-existing-root` previously had no easy
way to find the ostree deployment before rebooting in order to inject
configuration files. This addresses that gap.

Key changes:

- Document using `ostree admin --print-current-dir` to find the newly
  created deployment path before rebooting
- Clarify the two distinct scenarios: injecting new configuration
  before reboot vs. migrating old data after reboot
- Add examples for both file-based configuration and kernel arguments
  (via `systemd.mount-extra`)
- Cross-link documentation between general install docs and the
  to-existing-root man page
- Fix typo in path structure documentation

Related: https://github.com/bootc-dev/bootc/issues/531

Assisted-by: Claude Code (Sonnet 4.5)
Signed-off-by: Colin Walters <walters@verbum.org>
2025-11-21 16:38:26 -05:00
Colin Walters
9142b88a54 docs: Add a man page for bootc-root-setup
On general principle.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-11-19 11:24:07 -05:00
Colin Walters
4c2377bc42 docs: Add a packaging-and-integration guide
Signed-off-by: Colin Walters <walters@verbum.org>
2025-11-19 11:06:31 -05:00
Colin Walters
a998bfc3f1 install: Fix DPS support
This fixes bootc's use of the Discoverable Partition Specification (DPS)
to properly support systemd-gpt-auto-generator. Previously, bootc was
incorrectly setting filesystem UUIDs to the DPS partition type UUID value,
which caused UUID collisions and prevented proper DPS functionality.

It's still a TODO on our side to support systemd-repart in this flow.

Note we go back to using random filesystem UUIDs with this, but
per above we should likely reinitialize them on boot via repart.

Note we remove root= parameter from kernel cmdline for composefs sealed images,
allowing systemd-gpt-auto-generator to auto-discover the root partition
and we test this.

Fixes: #1771

Assisted-by: Claude Code (Sonnet 4.5)
Signed-off-by: Colin Walters <walters@verbum.org>
2025-11-18 11:02:22 -05:00
Colin Walters
63d09b6a7e install: Expand on root_mount_spec option
Came up in chat.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-11-17 09:38:28 -05:00
Micah Abbott
71dcf84334 docs: fix symlink command
Closes: #1731

Signed-off-by: Micah Abbott <miabbott@redhat.com>
2025-11-12 10:36:33 -05:00
ckyrouac
338aaab0e4 docs: Add docs for install reset to experimental section
Assisted-by: Claude Code
Signed-off-by: ckyrouac <ckyrouac@redhat.com>
2025-10-30 17:16:39 -04:00
Colin Walters
706ff868b6 lib: Remove composefs-backend feature gate
While composefs is still experimental, after looking at this
I think the feature gating we're doing has a pretty high "pain:gain"
ratio - in other words, the risk we're mitigating by having it
off is very low.

Since composefs is a focus of development, let's just remove
the feature gate. We have good CI coverage for the non-composefs
case.

Assisted-by: Claude Code (Sonnet 4.5)
Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-29 11:01:18 -04:00
Colin Walters
37fa085be9 docs: Add experimental-composefs
It's way overdue for us to have a doc section, add one!

Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-27 14:56:18 -04:00
bootc-bot[bot]
8eae370b03 Release 1.10.0 (#1704)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: bootc-bot[bot] <225049296+bootc-bot[bot]@users.noreply.github.com>
2025-10-27 10:32:28 -07:00
John Eckersberg
84c7a19d25 Fix a few instances of oddball baud rate
Claude pointed this out while I was working on something else
completely unrelated.  But it looks like somewhere along the way
114800 snuck its way in and probably got copy/pasted into a few
places.  The maximum baud rate is 115200[1], and that is the more
typical usage.

[1] https://www.kernel.org/doc/html/latest/admin-guide/serial-console.html

Signed-off-by: John Eckersberg <jeckersb@redhat.com>
2025-10-21 18:37:48 -04:00
Colin Walters
817d7d11f9 switch: Document digests
Came up in chat.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-21 11:20:49 -04:00
Colin Walters
f4c678eb88 Various composefs enhancements
- Change the install logic to detect UKIs and automatically
  enable composefs
- Change the install logic to detect absence of bootupd
  and default to installing systemd-boot
- Move sealing bits to the toplevel
- Add Justfile entrypoints
- Add basic end-to-end CI coverage (install + run) using
  our integration tests
- Change lints to ignore `/boot/EFI`

Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-16 14:48:21 -04:00
Colin Walters
87d1d391ff Enable composefs by default
Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-16 14:48:21 -04:00
Colin Walters
a13ba6d93a status: Mention rpm-ostree vs bootc
Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-07 18:20:05 -04:00
Colin Walters
24f2dd0b87 Expand/consolidate "detecting bootc"
Continually comes up.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-10-06 16:32:55 -04:00
Colin Walters
c88d87cd35 docs: Add a man page for system-reinstall-bootc
This is an important gap.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-09-29 09:15:09 -04:00
Guillaume Assier 🌤️
793e03064e Update docs/src/registries-and-offline.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Guillaume Assier 🌤️ <18405490+GuillaumeASSIER@users.noreply.github.com>
2025-09-28 14:45:36 -04:00
GuillaumeAssier
d34087419a docs: Adding a private OCI registry section
Signed-off-by: GuillaumeAssier <sykursen@protonmail.com>
2025-09-28 14:45:36 -04:00
Colin Walters
788162f6cf Move docs workflow into Justfile + container
This drains nontrivial logic out GHA and into something
isolated via containers and driven via `Justfile` and
easily replicable locally too.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-09-26 15:23:34 -04:00
Colin Walters
856a7fba7c build-sys: A lot more manpage followups
- Remove duplicated logic between xtask and makefile
  for converting markdown; it needs to be in xtask
  as we handle the version substitution there and
  some other tweaks
- Really just make the developer entrypoint `just update-generated`
  in general
- Fix the rendering of booleans
- Remove unnecessary emoji from prints

Signed-off-by: Colin Walters <walters@verbum.org>
2025-09-18 09:05:36 -04:00
Colin Walters
2ca2886cee docs: Fix links to man pages
Followup to https://github.com/bootc-dev/bootc/pull/1587
Closes: https://github.com/bootc-dev/bootc/issues/1616

Signed-off-by: Colin Walters <walters@verbum.org>
2025-09-17 17:56:58 -04:00
Colin Walters
d438aaf9ec Switch to hand-written man pages with auto option sync
See the updates to `Justfile` for how to use this.

Closes: #1428

Assisted-By: Claude Code (opus + sonnet)
Signed-off-by: Colin Walters <walters@verbum.org>
2025-09-12 16:13:49 -04:00
bootc-bot[bot]
e04d5c41af Release 1.8.0
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-09-04 21:31:00 +00:00
bootc-actions-token[bot]
5e687f7472 Release 1.7.1
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-08-25 21:55:55 +00:00
bootc-actions-token[bot]
ae8930b1ad Release 1.7.0
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-08-21 16:33:13 -04:00
bootc-actions-token[bot]
acba07b6fb Release 1.6.0
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-08-07 10:01:43 -04:00
Colin Walters
4e455d6652 docs: We're read only by default in a container (#1474)
* docs: We're read only by default in a container

Closes: https://github.com/bootc-dev/bootc/issues/1461
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-08-01 13:06:29 -04:00
gursewak1997
4407a371e5 docs: add documentation for root.transient-ro feature
Add comprehensive documentation for the root.transient-ro option that allows
privileged users to create dynamic top-level mountpoints at runtime while
keeping the filesystem read-only by default.
2025-07-31 13:45:53 -07:00
Colin Walters
e2d21f7bf1 Update docs/src/building/users-and-groups.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2025-07-29 11:27:40 -04:00
Colin Walters
fddadc2ccb docs: Elaborate a bit on sysusers and /usr
Don't do it, make your /usr content root owned.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-07-29 10:43:51 -04:00
jbtrystram
560711d148 install: skip mountspec kargs when passed empty rootspec
Notably, we skip generating an fstab entry for boot, even if it's on a
separate partition. this requires the image initramfs have some
knowledge to find the rootfs and bootfs (labels or DPS).

See https://github.com/bootc-dev/bootc/issues/1441
2025-07-28 16:51:44 +02:00
Colin Walters
00359bf1ca Release 1.5.1 2025-07-17 13:04:02 -04:00
ckyrouac
b290ad25c7 Release 1.5.0
Signed-off-by: ckyrouac <ckyrouac@redhat.com>
2025-07-16 13:56:23 -04:00
Colin Walters
86b45a592e secrets: Expand on authfile
- Note the existence of `/run` here
- Describe how to use `podman login --authfile` to write it
- Also describe the pattern of symlinking to keep things in sync
  where desired

Signed-off-by: Colin Walters <walters@verbum.org>
2025-06-30 17:50:56 -04:00
John Eckersberg
1b3f1411c3 docs: Update generated
Signed-off-by: John Eckersberg <jeckersb@redhat.com>
2025-06-27 17:35:36 -04:00
FT
e3262f440f Update guidance.md 2025-06-15 14:12:19 +02:00
FT
a8830d0785 Update users-and-groups.md 2025-06-15 14:11:52 +02:00
fuder.eth
10435b9b8a Update filesystem-sysroot.md 2025-06-13 20:01:44 +02:00
fuder.eth
4590b650d3 Update relationship-particles.md 2025-06-13 20:01:16 +02:00
kilavvy
91b64485ee Update relationship-particles.md 2025-06-12 15:49:03 +02:00
Colin Walters
e0b176999c kargs: Clarify a bit more
- Changes via `rpm-ostree kargs` will persist, this came up
  as a question
- Explicitly mention the `unshare -m` trick
- Emphasize a bit more bootc+rpm-ostree do interoperate;
  except for removing things added by `/usr/lib/bootc/kargs.d`,
  don't do that
2025-06-11 08:22:28 +02:00
Colin Walters
726041f5ba Merge pull request #1354 from cgwalters/doc-bootloader
docs: Add bootloaders.md
2025-06-06 12:01:36 -04:00
Colin Walters
88a830a5af docs: Add bootloaders.md
This one is important.

Signed-off-by: Colin Walters <walters@verbum.org>
2025-06-05 13:06:21 -04:00
ckyrouac
10637b5a3f reinstall: Docs for cleanup script and mount points
Signed-off-by: ckyrouac <ckyrouac@redhat.com>
2025-06-03 10:22:37 -04:00
John Eckersberg
ca7b38f699 Rewrite containers org links to bootc-dev org
Literally just find and replace github.com/containers/bootc with
github.com/bootc-dev/bootc

We have the redirect in place so none of this is really important, but
I figure removing as many instances of the old repo and replacing them
with the current can't hurt for things like search engine
optimization.  Plus some non-zero number of people might assume one is
a fork of the other or something.

Signed-off-by: John Eckersberg <jeckersb@redhat.com>
2025-05-22 09:07:36 -04:00
Colin Walters
59232f0635 docs: Fix typos and clarify content
Especially fix the intro and note that bootc's APIs are stable.

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Colin Walters <walters@verbum.org>
2025-05-16 20:47:29 -04:00
Colin Walters
c1d67aa07c Merge pull request #1315 from cgwalters/doc-initramfs-transient
filesystem: Note initramfs reneneration is required for prepare-root
2025-05-13 10:17:57 -04:00
Colin Walters
c33202e7a6 filesystem: Note initramfs reneneration is required for prepare-root
Ref https://gitlab.com/fedora/bootc/examples/-/merge_requests/59#note_2500726902
2025-05-13 11:33:02 +00:00
omahs
4e19c8e1ba docs: fix typos 2025-05-10 09:12:10 +02:00