Skip to content

Commit 0cc171e

Browse files
committed
doc: build command
Introduce the `build` command. Signed-off-by: Simon de Vlieger <[email protected]>
1 parent ca7ea33 commit 0cc171e

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

doc/01-usage.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,22 @@ $ image-builder list-images --filter type:qcow2 --filter distro:fedora-41
9696
# ... list ...
9797
```
9898

99+
## `image-builder build`
100+
101+
The `build` command builds images of a given [image type](./10-faq.md#image-types), for example:
102+
103+
```console
104+
$ sudo image-builder build minimal-raw
105+
# ... progress ...
106+
```
107+
108+
By default the `build` command uses the same distribution and version as the host system, you can pass another distribution and version with the `--distro` argument:
109+
110+
```console
111+
$ sudo image-builder build --distro fedora-43 minimal-raw
112+
# ... progress ...
113+
```
114+
99115
# Blueprints
100116

101117
Images can be customized with [blueprints](https://osbuild.org/docs/user-guide/blueprint-reference). For example we could build the `qcow2` we built above with some customizations applied.

doc/10-faq.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,9 @@ The above can be quite confusing, hence we've created `image-builder`. It allows
1515
## Why does `image-builder` need `root` permissions?
1616

1717
For image types where we need to work with filesystems we need root. Mounting and working with filesystems is not namespaced in the Linux kernel and mounting filesystems is generally considered to be "running untrusted code in the kernel" hence it requires root permissions.
18+
19+
## Built-in distributions
20+
21+
- Fedora
22+
- CentOS
23+
- RHEL

0 commit comments

Comments
 (0)