Commit graph

28 commits

Author SHA1 Message Date
Michael Vogt
a454b2e96c README.md: document --ignore-warnings
This commit adds some documentation to the `--ignore-warnings`
flag that was added in PR#250.
2025-07-30 10:01:36 +00:00
Simon de Vlieger
3cabb30ff8 readme: mention mount for container
People often forget to mount, we're a bit clearer about this in
`bootc-image-builder`; let's make it clear here as well.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-06-27 19:50:15 +00:00
Lukas Zapletal
10dde06c33 docs: subscription basic info 2025-06-25 09:02:35 +00:00
Michael Vogt
7af1a8d8b3 README.md: add a section about adding "registrations"
This is a small followup for
https://github.com/osbuild/image-builder-cli/pull/201
to include information about how to use the new
`--registrations` option.
2025-04-28 09:51:43 +00:00
Simon de Vlieger
274a75387b main: rename list-images to list
Rename the `list-images` command to `list`. We don't have `-image(s)` in
our other subcommands so this is for consistency.

We keep a `list-images` alias behind for compatibility reasons.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-04-08 07:34:20 +00:00
Michael Vogt
c0248a1c24 README: document that cross building works
Document how cross building works.
2025-03-25 14:27:31 +00:00
Simon de Vlieger
cefe2f8527 readme: update installation instructions
Mention installability in Fedora. Provide COPR enable instructions.
Mention the container.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-03-03 10:37:39 +00:00
Simon de Vlieger
4d9cf723fd main: rename output to format
We had a chat about this and we feel that `format` is less ambiguous a
name for this argument.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-02-27 10:58:11 +00:00
Simon de Vlieger
58aa0cf87b main: rename basedir -> base-dir
Rename the `basedir` argument to be consistent with `output-dir`
by hyphenation.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-02-27 10:58:11 +00:00
Michael Vogt
a8d6751e19 docs: describe the way to add/override repositories
This commit adds some documentation on how the repositories can
be manipulated.
2025-02-13 11:31:06 +00:00
Michael Vogt
25f21a3205 main: add upload support directly to build
This commit adds support to upload the build image directly to
the target cloud. Currently only ami/AWS is supported.

If the cloud specific configuration is given at the commandline
and the image type is a cloud image the cloud upload will happen
automatically (just like with bib). Incomplete upload config is
an error.
2025-02-11 13:38:04 +01:00
Simon de Vlieger
2455b9d586 doc: initial documentation
Supply initial documentation for `image-builder`. This documentation
will be imported into the osbuild [1] website.

[1]: https://osbuild.org/

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-01-31 08:06:22 +00:00
Michael Vogt
279fa163d6 README: add FAQ about relation between bib and ibcli
This commit adds a small FAQ entry to explain the relation between
`bib` and `ibcli`.

Thanks to Jonathan Lebon for the suggesiton.

Closes: https://github.com/osbuild/image-builder-cli/issues/89
2025-01-28 11:03:16 +00:00
Florian Schüller
f10766506d README: document required dependency
As a dependency of `images` we also need `gpgme-devel` here,
if we compile without `containers_image_openpgp`.
2025-01-21 14:20:18 +00:00
Simon de Vlieger
c136684426 README: mention sbom/manifest
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-01-20 15:42:21 +00:00
Michael Vogt
0580eb1106 main: add --extra-artifacts=manifest
This commit adds support for `--extra-artifacts=manifest`. If
that is given as part of the build an extra artifacts called
`<img-name>.osbuild-manifest.json` will be created in the
output directory.

Closes: https://github.com/osbuild/image-builder-cli/issues/42
2025-01-20 14:12:30 +00:00
Simon de Vlieger
37791d3c76 readme: refer to new COPR
Refer to a COPR by the new `image-builder` name.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-01-20 13:32:25 +00:00
Michael Vogt
ca0c9e63bd README: document the new --extra-artifacts=sbom option
Small commit that tweaks the README to include this new option.
2025-01-19 21:57:14 +00:00
Simon de Vlieger
3fb26dbffe doc: update README
Use the new `--blueprint` in the README.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2025-01-16 12:31:13 +00:00
Michael Vogt
44f8f90310 README: add blueprint example
This commit adds an example for how to pass the blueprint and what
content the blueprint should have.
2025-01-13 13:46:14 +00:00
Michael Vogt
d35c95a9bc lint: fix whitespace/spelling in README 2025-01-10 08:30:28 +00:00
Michael Vogt
80cadaf291 repos: lookup <buildin>, /{etc,usr/share}/image-builder/repositories
This commit switches the default repositories to use the build-in
ones from images PR#1112. It is still possible to override using
`/etc/image-builder` and `/usr/share/image-builder` or `--datadir`.

This is implicitly tested via the container test that no longer
includes the files from osbuild-composer in the container.
2025-01-09 16:17:50 +00:00
Florian Schüller
734c132500 prepare all syntax for linters and spellchecks 2025-01-07 12:29:58 +00:00
Michael Vogt
5aa75ec1c1 Containerfile: initial version
This commit adds an initial Containerfile to build an `image-builder`
container.

Use all the DNF commands together and add a cleaning command to the end
of it. This makes fewer layers and keeps the image size slightly
smaller.

Co-authored-by: Simon de Vlieger <supakeen@redhat.com>
Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2024-12-19 08:49:26 +00:00
Michael Vogt
e5b3ccd6ed cmd: add new build command
This commit adds the `build` command. It takes the same flags as
`manifest` and will build the specified image.
2024-12-16 14:59:08 +00:00
Simon de Vlieger
ea7b58bd5c chore: README blurbs
Add the common blurb(s) that are on all Image Builder project READMEs.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
2024-12-16 09:13:47 +00:00
Michael Vogt
99bd43e7d4 README: document install, prerequists and list-images
This commit adds some examples and how to use to the README.
2024-11-29 10:52:28 +00:00
Michael Vogt
c718759dea README.md: initial draft 2024-11-12 09:47:16 +01:00