Skip to content

Commit 091840b

Browse files
authored
Merge pull request #691 from cgwalters/doc-experimental
docs: Add experimental section w/`bootc image`
2 parents d91c00a + f68ef1a commit 091840b

File tree

3 files changed

+38
-0
lines changed

3 files changed

+38
-0
lines changed

.github/workflows/docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ concurrency:
1414
group: "pages"
1515
cancel-in-progress: false
1616

17+
# To build the docs locally you can also do e.g.:
18+
# cargo install mdbook-mermaid
19+
# cd docs
20+
# mdbook-mermaid install
21+
# mdbook serve
22+
1723
jobs:
1824
build:
1925
runs-on: ubuntu-latest

docs/src/SUMMARY.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@
4444
- [Filesystem: sysroot](filesystem-sysroot.md)
4545
- [Container storage](filesystem-storage.md)
4646

47+
# Experimental features
48+
49+
- [bootc image](experimental-bootc-image.md)
50+
4751
# More information
4852

4953
- [Package manager integration](package-managers.md)

docs/src/experimental-bootc-image.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# bootc image
2+
3+
Experimental features are subject to change or removal. Please
4+
do provide feedback on them.
5+
6+
Tracking issue: <https://github.com/containers/bootc/issues/690>
7+
8+
## Using `bootc image copy-to-storage`
9+
10+
This experimental command is intended to aid in [booting local builds](booting-local-builds.md).
11+
12+
Invoking this command will default to copying the booted container image into the `containers-storage:`
13+
area as used by e.g. `podman`, under the image tag `localhost/bootc` by default. It can
14+
then be managed independently; used as a base image, pushed to a registry, etc.
15+
16+
Run `bootc image copy-to-storage --help` for more options.
17+
18+
Example workflow:
19+
20+
```
21+
$ bootc image copy-to-storage
22+
$ cat Containerfile
23+
FROM localhost/bootc
24+
...
25+
$ podman build -t localhost/bootc-custom .
26+
$ bootc switch --transport containers-storage localhost/bootc-custom
27+
```
28+

0 commit comments

Comments
 (0)