doc: provide links in FAQ

Fill in the links that were placeholders to the appropriate places.

Signed-off-by: Simon de Vlieger <supakeen@redhat.com>
This commit is contained in:
Simon de Vlieger 2025-02-06 09:54:11 +01:00
parent dd954a7c6b
commit 6b97573d2e

View file

@ -6,11 +6,11 @@ As we receive questions we'll fill in the frequent ones here.
The Image Builder team provides a bunch of tools that people can use to build, define, and customize operating system images. Amongst those are:
1. The [Image Builder service]() on the [Red Hat Console]() which lets users build images through an API or user interface, automatically upload images to their favorite hyperscalers. It integrates there with various other services such as custom content.
2. [osbuild-composer]() is the component that provides APIs for the [Image Builder service]() in such a way that you can host them locally.
3. [weldr-client]() is an application that uses the [osbuild-composer]() provided APIs to offer a local command line program to start, stop, and manage builds.
1. The [Image Builder service](https://console.redhat.com/insights/image-builder/) on the [Red Hat Console](https://console.redhat.com/) which lets users build images through an API or user interface, automatically upload images to their favorite hyperscalers. It integrates there with various other services such as custom content.
2. [osbuild-composer](https://github.com/osbuild/osbuild-composer) is the component that provides APIs for the [Image Builder service](https://console.redhat.com/insights/image-builder/) in such a way that you can host them locally.
3. [weldr-client](https://github.com/osbuild/weldr-client) is an application that uses the [osbuild-composer](https://github.com/osbuild/osbuild-composer) provided APIs to offer a local command line program to start, stop, and manage builds.
The above can be quite confusing, hence we've created `image-builder`. It allows you to do the same things as [weldr-client]() except it does so without the need to run [osbuild-composer](). Builds are done directly without going through other layers. This makes [image-builder]() easier to install and use in a lot of environments.
The above can be quite confusing, hence we've created `image-builder`. It allows you to do the same things as [weldr-client](https://github.com/osbuild/weldr-client) except it does so without the need to run [osbuild-composer](https://github.com/osbuild/osbuild-composer). Builds are done directly without going through other layers. This makes [image-builder](https://github.com/osbuild/image-builder-cli) easier to install and use in a lot of environments.
## Why does `image-builder` need `root` permissions?