This is an automated email from the ASF dual-hosted git repository.
rohit pushed a commit to branch 4.20
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/4.20 by this push:
new f4a58b5 notes on guest os category changes and modern image selection
(#500)
f4a58b5 is described below
commit f4a58b5fb056ad504415d944f74f558749899084
Author: Abhishek Kumar <[email protected]>
AuthorDate: Tue Jun 10 15:27:40 2025 +0530
notes on guest os category changes and modern image selection (#500)
* notes on guest os category changes and modern image selection
Related #10773
Signed-off-by: Abhishek Kumar <[email protected]>
* Update source/releasenotes/about.rst
Co-authored-by: Vishesh <[email protected]>
* image fix attempt
* add form fix
* typo
---------
Signed-off-by: Abhishek Kumar <[email protected]>
Co-authored-by: Vishesh <[email protected]>
---
source/_static/images/add-guest-os-category.png | Bin 0 -> 14908 bytes
source/_static/images/guest-os-categories.png | Bin 0 -> 118529 bytes
.../_static/images/ui-legacy-image-selection.png | Bin 0 -> 174185 bytes
.../_static/images/ui-modern-image-selection.png | Bin 0 -> 160631 bytes
source/adminguide/guest_os.rst | 43 ++++++++++++++-
source/adminguide/ui.rst | 61 +++++++++++++++------
source/releasenotes/about.rst | 10 ++++
7 files changed, 94 insertions(+), 20 deletions(-)
diff --git a/source/_static/images/add-guest-os-category.png
b/source/_static/images/add-guest-os-category.png
new file mode 100644
index 0000000..fd2a724
Binary files /dev/null and b/source/_static/images/add-guest-os-category.png
differ
diff --git a/source/_static/images/guest-os-categories.png
b/source/_static/images/guest-os-categories.png
new file mode 100644
index 0000000..3bb567c
Binary files /dev/null and b/source/_static/images/guest-os-categories.png
differ
diff --git a/source/_static/images/ui-legacy-image-selection.png
b/source/_static/images/ui-legacy-image-selection.png
new file mode 100644
index 0000000..828800a
Binary files /dev/null and
b/source/_static/images/ui-legacy-image-selection.png differ
diff --git a/source/_static/images/ui-modern-image-selection.png
b/source/_static/images/ui-modern-image-selection.png
new file mode 100644
index 0000000..2fe0125
Binary files /dev/null and
b/source/_static/images/ui-modern-image-selection.png differ
diff --git a/source/adminguide/guest_os.rst b/source/adminguide/guest_os.rst
index cb64f57..04b8ec1 100644
--- a/source/adminguide/guest_os.rst
+++ b/source/adminguide/guest_os.rst
@@ -13,6 +13,13 @@
specific language governing permissions and limitations
under the License.
+
+.. |guest-os-categories.png| image:: /_static/images/guest-os-categories.png
+ :alt: Guest OS Categories
+
+.. |add-guest-os-category.png| image::
/_static/images/add-guest-os-category.png
+ :alt: Add Guest OS Category form
+
.. |guest-os-button.png| image:: /_static/images/guest-os-button.png
:alt: Guest OS section
@@ -36,8 +43,40 @@ and also need to have a mapping with the actual operating
system name supported
Under "Configuration" section there are sub-sections for guest operating
system.
+Guest OS Categories
+-------------------
+
+A list of existing categories for the guest operating systems are shown as
+"Guest OS Categories" section. Operators can also add new guest operating
+system categories from the view.
+
+|guest-os-categories.png|
+
+Guest operating system categories are useful for categorizing images, i.e.,
+templates and ISOs, in several UI forms such as deploying an instance,
+reinstalling an instance, etc., when the modern image selection is used in the
+UI configuration.
+
+To allow a guest operating system category to be displayed in the UI forms, it
+must be marked as featured. The order of the categories can also be controlled
+using the Order option in the categories view.
+
+Like other resources, a custom resource icon can be set for a particular guest
+operating system category for further control. If no resource icon is set for
+a category, the UI will display default icons based on the category
+name.
+
+An existing guest OS category can be deleted if it does not have any
+associated guest operating systems.
+
+The "Add guest OS category" option allows operators to create new categories,
+which can be marked as featured if they are meant to be displayed in the UI
+forms.
+
+|add-guest-os-category.png|
+
Guest OS
----------
+--------
A list of supported guest operating systems are shown under
|guest-os-button.png| and also one can add new operating systems.
@@ -86,4 +125,4 @@ and following details needs to be provided.
:align: center
:alt: Guest OS mapping form
-Operator can also do operations like edit and delete guest OS and its
hypervisor mappings.
\ No newline at end of file
+Operator can also do operations like edit and delete guest OS and its
hypervisor mappings.
diff --git a/source/adminguide/ui.rst b/source/adminguide/ui.rst
index 3a84aa2..3d768a1 100644
--- a/source/adminguide/ui.rst
+++ b/source/adminguide/ui.rst
@@ -178,30 +178,33 @@ new, unique value.
#. Type the new password, and click OK.
-Basic UI Customization
+Basic UI Customisation
~~~~~~~~~~~~~~~~~~~~~~
Users can customize the CloudStack's user interface by means of a
configuration file at /etc/cloudstack/management/config.json which can be used
to modify the theme, logos, etc. to align to one's requirement.
To change the logo, login banner, error page icon, etc. the following details
can be edited in config.json:
-=============================
================================================================
+=======================================
==================================================================================================================================================================
Property Description
-=============================
================================================================
-apiBase Changes the suffix for the API endpoint
-docBase Changes the base URL for the documentation
-appTitle Changes the title of the portal
-footer Changes the footer text
-loginFavicon Changes the favicon of the login page
-loginFooter Configure to display text (HTML) in the footer
at the login screen
-loginTitle Changes the title of the login page
-logo Changes the logo top-left side image
-minilogo Changes the logo top-left side image when menu
is collapsed
-banner Changes the login banner image
-error.404 Changes the image of error Page not found
-error.403 Changes the image of error Forbidden
-error.500 Changes the image of error Internal Server Error
-=============================
================================================================
+=======================================
==================================================================================================================================================================
+apiBase Changes the suffix for the API endpoint
+docBase Changes the base URL for the
documentation
+appTitle Changes the title of the portal
+footer Changes the footer text
+loginFavicon Changes the favicon of the login page
+loginFooter Configure to display text (HTML) in
the footer at the login screen
+loginTitle Changes the title of the login page
+logo Changes the logo top-left side image
+minilogo Changes the logo top-left side image
when menu is collapsed
+banner Changes the login banner image
+error.404 Changes the image of error Page not
found
+error.403 Changes the image of error Forbidden
+error.500 Changes the image of error Internal
Server Error
+imageSelectionInterface Allows specifying view for
image(template/ISO) selection in several UI forms. Supported values are:
"modern" and "legacy". Default view is "modern"
+showUserCategoryForModernImageSelection Enables showing or hiding _User_
category in the *modern* image selection view which will show all user-owned
images for the logged in user. Default value is true
+showAllCategoryForModernImageSelection Enables showing or hiding _All_
category in the *modern* image selection view which will show all available
images for the logged in user. Default value is false
+=======================================
==================================================================================================================================================================
.. parsed-literal::
@@ -219,7 +222,7 @@ error.500 Changes the image of error
Internal Server Error
}
-Customization of themes is also possible, such as, modifying banner width,
general color, etc. This can be done by editing the "theme" section of the
config.json file. Theme section provides following properties for customization:
+Customisation of themes is also possible, such as, modifying banner width,
general color, etc. This can be done by editing the "theme" section of the
config.json file. Theme section provides following properties for customisation:
=============================
================================================================
Property Description
@@ -497,6 +500,22 @@ For displaying a custom HTML in the plugin, HTML file can
be stored in the Cloud
|ui-custom-plugin.png|
+
+Instance Image Selction Customisation
+-------------------------------------
+
+In the UI, there are several forms where the user needs to select an image
(template/ISO) for an instance, such as deploying an instance, reinstalling an
instance, creating a VNF appliance, etc. The image selection interface for
these forms can be selected by the operator based on preference by specifying
properties in the UI configuration file (config.json).
+
+The configuration property _imageSelectionInterface_ can be set to one of
these values: modern or legacy. The default value is *modern*.
+
+When the *modern* interface is used, images will be categorized based on the
guest operating system categories. Further customisation can be done using the
configuration properties showUserCategoryForModernImageSelection and
showAllCategoryForModernImageSelection to allow or disallow the display of
additional categories.
+
+|ui-modern-image-selection.png|
+
+The *legacy* interface will display images based on templatefilter/isofilter,
i.e., Featured, Community, My Templates/ISOs, and Shared.
+
+|ui-legacy-image-selection.png|
+
Advanced UI Customisation
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -589,6 +608,12 @@ The following features are no longer supported or
available in the UI but are st
.. |change-password.png| image:: /_static/images/change-password.png
:alt: button to change a User's password
+.. |ui-modern-image-selection.png| image::
/_static/images/ui-modern-image-selection.png
+ :alt: Modern Image Selection
+
+.. |ui-legacy-image-selection.png| image::
/_static/images/ui-legacy-image-selection.png
+ :alt: Legacy Image Selection
+
.. |ui-custom-plugin.png| image:: /_static/images/ui-custom-plugin.png
:alt: Custom plugin shown in UI with navigation
diff --git a/source/releasenotes/about.rst b/source/releasenotes/about.rst
index bc86fad..6eb7c7e 100644
--- a/source/releasenotes/about.rst
+++ b/source/releasenotes/about.rst
@@ -72,7 +72,17 @@ This means that Centos7 (EL7) is no longer supported.
Events Message Bus Change
=========================
+
On upgrading from 4.19.x or lower, existing AMQP or Kafka intergration
configurations should be moved from folder
``/etc/cloudstack/management/META-INF/cloudstack/core`` to
``/etc/cloudstack/management/META-INF/cloudstack/event``
+
+Guest OS Categories Change
+==========================
+
+The guest operating system categories have been updated, resulting in a
+reorganization of the guest operating systems with respect to categories.
+
+If the ``oscategoryid`` functionality for hosts is being used, ensure it is
+pointing to the correct guest operating system category ID.
