Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add experimental section w/bootc image #691

Merged
merged 2 commits into from
Jul 18, 2024
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
6 changes: 6 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ concurrency:
group: "pages"
cancel-in-progress: false

# To build the docs locally you can also do e.g.:
# cargo install mdbook-mermaid
# cd docs
# mdbook-mermaid install
# mdbook serve

jobs:
build:
runs-on: ubuntu-latest
Expand Down
4 changes: 4 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@
- [Filesystem: sysroot](filesystem-sysroot.md)
- [Container storage](filesystem-storage.md)

# Experimental features

- [bootc image](experimental-bootc-image.md)

# More information

- [Package manager integration](package-managers.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/src/experimental-bootc-image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# bootc image

Experimental features are subject to change or removal. Please
do provide feedback on them.

Tracking issue: <https://github.com/containers/bootc/issues/690>

## Using `bootc image copy-to-storage`

This experimental command is intended to aid in [booting local builds](booting-local-builds.md).

Invoking this command will default to copying the booted container image into the `containers-storage:`
area as used by e.g. `podman`, under the image tag `localhost/bootc` by default. It can
then be managed independently; used as a base image, pushed to a registry, etc.

Run `bootc image copy-to-storage --help` for more options.

Example workflow:

```
$ bootc image copy-to-storage
$ cat Containerfile
FROM localhost/bootc
...
$ podman build -t localhost/bootc-custom .
$ bootc switch --transport containers-storage localhost/bootc-custom
```