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

user-guide/00-introduction: Describe image builder output formats #146

Merged
merged 2 commits into from
Feb 13, 2025

Conversation

schuellerf
Copy link
Contributor

Add short hint on the difference between
image-installer and live-installer.

@schuellerf
Copy link
Contributor Author

Please give me some hints if I got it right. Is there some better / more detailed documentation about those types somewhere?

@ht-vo
Copy link
Contributor

ht-vo commented Jan 21, 2025

Hi @schuellerf, to keep it short, isn't it clearer to describe this way:

  • Installer (unattended)
  • Installer (interactive mode)

@schuellerf
Copy link
Contributor Author

As far as I tested - It's not 'unattended' just more things preconfigured…

@schuellerf schuellerf force-pushed the describe-installer-types branch 2 times, most recently from b90a1f8 to fd05af6 Compare January 22, 2025 11:13
@schuellerf
Copy link
Contributor Author

Improved wording after collecting some input what happens in the background.

Copy link
Member

@achilleas-k achilleas-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a good idea to describe image types (especially the less obvious ones) in plain language, but I don't know if the current table is good for that. The first column, Description, isn't really a description so much as it is an acronym expansion for most image types. It's a bit weird to have a 2-3 word name for all image types except these two that have a short sentence describing them. Maybe all the other ones are obvious though? I don't know.

I'd propose changing the table to have the following columns:

  • Name
  • CLI name
  • File extension
  • Description

Obvious ones can have very short descriptions:

Name CLI name File extension Description
QEMU Image qcow2 .qcow2 QCOW2 formatted disk image for use with QEMU/Libvirt
Amazon Machine Image ami .ami Raw disk image for use with AWS EC2
Oracle Cloud Infrastructure Image oci .qcow2 QCOW2 formatted disk image for use with Oracle Cloud. This is identical to the qcow2 image.

And then the two installers can be described as

Name CLI name File extension Description
Image installer image-installer .iso Anaconda ISO with an embedded pre-built OS archive.
Live installer live-installer .iso Anaconda ISO with a live operating system.

Not sure those are the best descriptions for the ISOs, but we can workshop them.

@schuellerf schuellerf force-pushed the describe-installer-types branch 2 times, most recently from 563bb57 to 3aa43f4 Compare January 28, 2025 14:03
@schuellerf
Copy link
Contributor Author

schuellerf commented Jan 28, 2025

I reworked the table, although this might move into the application somewhere and the table here will ideally be generated, this might be a starting point.

Please double check if I understood the functionalities of the image types correctly

@schuellerf schuellerf changed the title user-guide/00-introduction: Describe *-installer types user-guide/00-introduction: Describe image builder output formats Jan 28, 2025
@schuellerf
Copy link
Contributor Author

@ht-vo as a hint. If the installer runs unattended or not, depends on the configuration. If all values are present for anaconda to continue it will be unattended otherwise it will ask. If "all necessary values" are configured is virtually impossible to check beforehand, anaconda decides…
…Hmm I should add a sentence like this to the docs also :-D

| VMware vSphere | ova | `.ova` | OVA formatted disk image for use with VMware vSphere. |
| Openstack | openstack | `.qcow2` | QCOW2 formatted disk image for use with OpenStack. |
| IoT Commit | iot-commit | `.tar` | OSTree-based image to be used as a new OSTree commit. |
| IoT Container | iot-container | `.tar` | OSTree-based commit packaged within a container image for containerized deployments. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The IoT (and Edge) containers are actually little web server containers that serve an ostree commit. It's meant to make it convenient to set up a single-commit ostree repo for building an ISO or disk image.

So maybe something like:

Web server container that embeds and serves an ostree repository with a single commit.

| VMware vSphere | vmdk | `.vmdk` | VMDK formatted disk image for use with VMware vSphere. |
| VMware vSphere | ova | `.ova` | OVA formatted disk image for use with VMware vSphere. |
| Openstack | openstack | `.qcow2` | QCOW2 formatted disk image for use with OpenStack. |
| IoT Commit | iot-commit | `.tar` | OSTree-based image to be used as a new OSTree commit. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think

OSTree commit archive.

is a bit more clear here. Calling it an image might imply it's a disk image, which it isn't. It's just a bare ostree commit tarball (which is actually an ostree repo with a single commit, but that's a bit too much of a detail).

@schuellerf schuellerf force-pushed the describe-installer-types branch from 3aa43f4 to 30e8cf7 Compare January 31, 2025 13:24
@schuellerf
Copy link
Contributor Author

I hope the description is better now
also for *-simplified-installer is that correct "… using FIDO or ignition."?

@schuellerf schuellerf force-pushed the describe-installer-types branch from 30e8cf7 to 70831c3 Compare February 11, 2025 08:54
Copy link
Member

@achilleas-k achilleas-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. LGTM

Rework the Image Builder output formats table to
contain a more concise description.
This documentation is actually part of osbuild.org
@schuellerf schuellerf force-pushed the describe-installer-types branch from 70831c3 to d23363b Compare February 13, 2025 12:56
@schuellerf schuellerf enabled auto-merge (rebase) February 13, 2025 12:56
@schuellerf schuellerf merged commit 0b3e0c4 into osbuild:main Feb 13, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants