Skip to content

Commit 8b31982

Browse files
authored
Merge branch 'main' into update-Host-LXC-Installation-page-of-Instllation-Guide
2 parents 0bbdd56 + 4b8f45e commit 8b31982

File tree

8 files changed

+113
-2
lines changed

8 files changed

+113
-2
lines changed
77.9 KB
Loading
144 KB
Loading
178 KB
Loading

source/adminguide/ui.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ the default username is password.
4545

4646
Domain -> If you are a root User, leave this field blank.
4747

48+
.. note::
49+
50+
Since 4.21 it is possible to login to a specific Project view by enabling the 'displayProjectFieldOnLogin' setting on config.json (which is disabled by default). Please refer to: :ref:`enable-login-to-project-view`.
51+
4852
If you are a User in the sub-domains, enter the full path to the domain,
4953
excluding the root domain.
5054

@@ -660,6 +664,23 @@ For the UI to work with different servers, it is necessary to configure the Ngin
660664
661665
|ui-multiple-server-management.png|
662666

667+
.. _enable-login-to-project-view:
668+
669+
Enable Login to Project View
670+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
671+
672+
User can use the file /etc/cloudstack/management/config.json to enable the Project field displayed on Login by the setting:
673+
674+
============================= =================================================================
675+
Property Description
676+
============================= =================================================================
677+
displayProjectFieldOnLogin Disabled by default. When enabled, login directly to Project view
678+
============================= =================================================================
679+
680+
When the Project field is set and the Project exists, the user is directly directed to the Project view instead of the Default View.
681+
682+
|ui-login-project-view.png|
683+
663684
Known Limitations
664685
~~~~~~~~~~~~~~~~~
665686

@@ -684,3 +705,6 @@ The following features are no longer supported or available in the UI but are st
684705

685706
.. |ui-multiple-server-management.png| image:: /_static/images/ui-multiple-server-management.png
686707
:alt: Custom plugin shown in UI with navigation
708+
709+
.. |ui-login-project-view.png| image:: /_static/images/ui-login-project-view.png
710+
:alt: Enabling the Project field on login

source/adminguide/vm_volume_allocators.rst

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,63 @@ firstfitleastconsumed Selects the first storage pool after sorting elig
7777

7878
**volume.allocation.algorithm**: random (default)
7979

80-
Before 4.21.0, **vm.allocation.algorithm** was used for both VM as well as Volume allocation.
80+
Before 4.21.0, **vm.allocation.algorithm** was used for both VM as well as Volume allocation.
81+
82+
83+
Cluster, Pod and Host Ordering
84+
==============================
85+
86+
Overview
87+
--------
88+
89+
`The host.capacityType.to.order.clusters` is a global advanced configuration parameter in Apache CloudStack that controls how pods, clusters,
90+
and hosts are prioritized during Instance deployment, based on available CPU, RAM, or a weighted combination of both in Host.
91+
This configuration is specifically leveraged when the VM allocation algorithm is set to `firstfitleastconsumed`.
92+
93+
Configuration
94+
-------------
95+
96+
Key: `host.capacityType.to.order.clusters`
97+
98+
.. cssclass:: table-striped table-bordered table-hover
99+
100+
========= ========================
101+
Value Behavior
102+
========= ========================
103+
CPU Prioritizes resources with the most available CPU.
104+
RAM Prioritizes resources with the most available memory.
105+
COMBINED Uses a weighted formula to balance CPU and RAM in prioritization.
106+
========= ========================
107+
108+
**Additional Configuration for COMBINED**
109+
110+
- Key: `host.capacityType.to.order.clusters.cputomemoryweight`
111+
- Type: Float(0.0 to 1.0)
112+
- Default: 0.5
113+
- Purpose: Determines the weight of CPU vs RAM in the combined capacity calculation.
114+
115+
Capacity calculation formula:
116+
117+
.. code:: bash
118+
119+
capacity = (host.capacityType.to.order.clusters.cputomemoryweight * CPU) + ((1 - host.capacityType.to.order.clusters.cputomemoryweight) * RAM)
120+
121+
122+
This allows flexible tuning of prioritization depending on workload sensitivity.
123+
124+
Example Configuration
125+
---------------------
126+
127+
.. code:: bash
128+
129+
host.capacityType.to.order.clusters: COMBINED
130+
host.capacityType.to.order.clusters.cputomemoryweight: 0.7
131+
132+
Above config prioritizes CPU at 70% weight and RAM at 30% when ranking pods, clusters, and hosts.
133+
134+
.. note::
135+
- `host.capacityType.to.order.clusters` is only respected for host ordering when:
136+
.. code:: bash
137+
138+
vm.allocation.algorithm: firstfitleastconsumed
139+
- When using COMBINED, make sure to tune cpu.to.memory.capacity.weight to reflect your environment’s resource constraints and workload profiles.

source/installguide/configuration.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ follow these procedures:
4747

4848
#. Add secondary storage to the zone. See :ref:`add-secondary-storage`.
4949

50+
#. Register Templates to the zone. See :ref:`register-templates`.
51+
5052
#. Initialize and test the new cloud. See :ref:`initialize-and-test`.
5153

5254
When you have finished these steps, you will have a deployment with the
@@ -1750,6 +1752,29 @@ You can add object storage pools at any time to add more capacity or providers
17501752

17511753
See https://min.io/docs/minio/linux/index.html for MinIO Documentation
17521754

1755+
1756+
.. _register-templates:
1757+
1758+
Register Cloud Templates
1759+
------------------------
1760+
1761+
For "KVM" hypervisor, admin can register cloud templates after Zone is enabled, through the optional step "Register Template"
1762+
1763+
#. After selecting kvm hypervisor:
1764+
1765+
|ZoneKVMRegisterTemplates.png: KVM Register Templates|
1766+
1767+
#. Register Template step in Zone wizard:
1768+
1769+
|ZoneRegisterTemplates.png: Zone Register Templates|
1770+
1771+
**Notes**
1772+
1773+
- Cloud image templates are hosted in http://download.cloudstack.org/templates/cloud-images/
1774+
- Metadata for the available templates is stored on the management server at: `/usr/share/cloudstack-management/webapp/cloud-image-templates.json`
1775+
- `MD5 <https://download.cloudstack.org/templates/cloud-images/md5sum.txt>`_ and `SHA512 <https://download.cloudstack.org/templates/cloud-images/sha512sum.txt>`_ checksums can be used to validate available cloud images for registration.
1776+
1777+
17531778
.. _initialize-and-test:
17541779

17551780
Initialize and Test
@@ -1973,3 +1998,5 @@ zone denied.routes Routes that
19731998
.. |add-Host.png: Adding a KVM Host| image:: /_static/images/add-Host.png
19741999
.. |ConsoleButton.png: button to launch a console| image:: /_static/images/console-icon.png
19752000
.. |AddObjectStore.png: Add Object Storage| image:: /_static/images/add-object-store.png
2001+
.. |ZoneKVMRegisterTemplates.png: KVM Register Templates| image:: /_static/images/zone-kvm-register-template.png
2002+
.. |ZoneRegisterTemplates.png: Zone Register Templates| image:: /_static/images/zone-register-templates.png

source/installguide/optional_installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Steps to Install the Usage Server
4848
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4949

5050
#. Package repository should already being configured. Refer to
51-
`Configure Package Repository <http://cloudstack-installation.readthedocs.org/en/latest/installation.html#configure-package-repository>`_
51+
`Configure Package Repository <../installguide/management-server/_pkg_repo.html#configure-package-repository>`_
5252

5353
#. Install package cloudstack-usage
5454

source/releasenotes/compat.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ and VMware with vSphere.
5050
- Alma Linux 8, 9 with KVM
5151
- Rocky Linux 8, 9 with KVM
5252
- Red Hat Enterprise Linux 8, 9 with KVM
53+
- Experimental support for Red Hat Enterprise Linux 10 with KVM
5354
- openSUSE Leap 15 with KVM
5455
- SUSE Linux Enterprise Server 15 with KVM
5556
- XCP-ng 8.2.0

0 commit comments

Comments
 (0)