Skip to content

Fixed issues in Image Building chapter in the Administration Guide bsc#1245987 #4173

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

Merged
merged 7 commits into from
Aug 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
- Fixed issues in Image Building chapter in the Administration Guide
(bsc#1245987)
- Fixed upgrade procedure for server and proxy in Installation and
Upgrade Guide (bsc#1247084)
- Added revision date to metadata for tracking document changes
Expand Down
32 changes: 22 additions & 10 deletions modules/administration/pages/image-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,20 @@
{productname} supports these two build types: Dockerfile and the Kiwi build type.
The Kiwi build type is used to build system, virtual, and other images.

The image store for the Kiwi build type is pre-defined as a file system directory at [path]``/srv/www/os-images`` on the server.
// Needs checking
// at later places to be fix accordingly
The image store for the Kiwi build type is pre-defined as a file system directory in the [path]``srv-www`` volume.
{productname} serves the image store over HTTPS from [literal]``https://<SERVER-FQDN>/os-images/``.
The image store location is unique and is not customizable.

Images are stored in [path]``/srv/www/os-image/ORGANIZATION-ID``.
Images are stored in an [path]``ORGANIZATION-ID`` directory there.


[[at.images.docker]]
== Container Images

image::image-building.png[scaledwidth=80%]
// FIXME, bsc#1245987: replace caas pattform with container host?
// image::image-building.png[scaledwidth=80%]


[[at.images.docker.requirements]]
Expand Down Expand Up @@ -114,6 +117,8 @@ For more information, see xref:client-configuration:activation-keys.adoc[].

All built images are pushed to an image store.
This section contains information about creating an image store.
Sometimes such a place for container images is referenced as a registry.


.Procedure: Creating Image Store
. Select menu:Images[Stores].
Expand Down Expand Up @@ -299,7 +304,7 @@ When you have selected a build profile, detailed information about the selected
[[at.images.docker.importing]]
=== Import an Image

The second way to build an image is to import and inspect arbitrary images.
The second way to get an image is to import and inspect arbitrary images.
To do that, select menu:Images[Image List] from the left navigation bar.
Complete the text boxes of the [guimenu]``Import`` dialog.
When it has processed, the imported image is listed on the [guimenu]``Image List`` page.
Expand Down Expand Up @@ -388,6 +393,10 @@ For more information, see the documentation of the underlying system.
[[at.images.kiwi.buildhost]]
=== Create a Build Host

// FIXME, bsc#1245987:
// Discussing Container-Based KIWI Image Build Support here?
// Perhaps 2.'docker' might be 2, but the container variant might be different?

To build all kinds of images with {productname}, create and configure a build host.
OS Image build hosts are {salt} clients running on {sles}{nbsp}15 (SP2 or later) or {sles}{nbsp}12 (SP4 or later).

Expand Down Expand Up @@ -479,7 +488,7 @@ Activation keys are mandatory for OS Image building.

[NOTE]
====
To build OS Images, you need an activation key that is associated with a channel other than `SUSE Manager Default`.
To build OS Images, you need an activation key that is associated with a channel other than `Default` activation key.
====

.Procedure: Creating an Activation Key
Expand All @@ -495,20 +504,23 @@ For more information, see xref:client-configuration:activation-keys.adoc[].
[[at.images.kiwi.imagestore]]
=== Create an Image Store

// For background info about Image Store, see the overview at the beginning of this chapter.

OS Images can require a significant amount of storage space.
Therefore, we recommended that the OS Image store is located on a partition of its own or on a Btrfs subvolume, separate from the root partition.
By default, the image store is located at [path]``/srv/www/os-images``.
By default, the image store is using the [path]``srv-www`` volume.


[NOTE]
====
Image stores for Kiwi build type, used to build system, virtual, and other images, are not supported yet.

// FIXME
ifeval::[{mlm-content} == true]
Images are always stored in [path]``/srv/www/os-images/ORGANIZATION-ID`` and are accessible via HTTP/HTTPS [url]``https://<susemanager_host>/os-images/ORGANIZATION-ID``.
Images are always stored in [path]``.../os-images/ORGANIZATION-ID`` and are accessible via HTTP/HTTPS [url]``https://<susemanager_host>/os-images/ORGANIZATION-ID``.
endif::[]

ifeval::[{uyuni-content} == true]
Images are always stored in [path]``/srv/www/os-images/ORGANIZATION-ID`` and are accessible via HTTP/HTTPS [url]``https://<uyuni_host>/os-images/ORGANIZATION-ID``.
Images are always stored in [path]``.../os-images/ORGANIZATION-ID`` and are accessible via HTTP/HTTPS [url]``https://<uyuni_host>/os-images/ORGANIZATION-ID``.
endif::[]

====
Expand Down Expand Up @@ -666,7 +678,7 @@ For information about the Kiwi build system, see the https://osinside.github.io/
[[at.images.kiwi.building]]
=== Build an Image

There are two ways to build an image using the {webui}.
There are two ways to build or get an image using the {webui}.
Either select menu:Images[Build], or click the build icon in the menu:Images[Profiles] list.

.Procedure: Building an Image
Expand Down
Loading