Skip to content

Commit ad87aec

Browse files
Merge pull request apache#61 from apache/instance-settings-doc-update
Added Instance Settings section
2 parents b0bd641 + 91f28c0 commit ad87aec

5 files changed

Lines changed: 42 additions & 1 deletion

File tree

10.9 KB
Loading
7.62 KB
Loading
9.59 KB
Loading
8.4 KB
Loading

source/adminguide/virtual_machines.rst

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1345,7 +1345,40 @@ CloudStack follows the below sequence of operations to provide GPU/vGPU support
13451345
GPU resources are released automatically when you stop a VM. Once the destroy VM is successful, CloudStack will make a resource call to the host to get the remaining GPU capacity in the card and update the database accordingly.
13461346

13471347

1348-
1348+
1349+
VM Instance Settings
1350+
~~~~~~~~~~~~~~~~~~~~
1351+
1352+
Each user VM has a set of "details" associated with it (as visible via listVirtualMachine API call) - those "details" are shown on the "Settings" tab of the VM in the GUI (words "setting(s)" and "detail(s)" are here used interchangeably).
1353+
1354+
The Settings tab is always present/visible, but settings can be changed only when the VM is in a Stopped state.
1355+
Some VM details/settings can be hidden via "user.vm.blacklisted.details" global setting (you can find below the list of those hidden by default).
1356+
1357+
When adding a new setting or modifying the existing ones, setting names are shown/offered in a drop-down list, as well as their possible values (with the exception of boolean or numerical values).
1358+
1359+
Read-only details/settings that are hidden by default:
1360+
1361+
- rootdisksize
1362+
- cpuOvercommitRatio
1363+
- memoryOvercommitRatio
1364+
- Message.ReservedCapacityFreed.Flag
1365+
1366+
An example list of settings as well as their possible values are shown on the images below:
1367+
1368+
|vm-settings-dropdown-list.PNG|
1369+
(VMware hypervisor)
1370+
1371+
|vm-settings-values-dropdown-list.PNG|
1372+
(VMware disk controllers)
1373+
1374+
|vm-settings-values1-dropdown-list.PNG|
1375+
(VMware NIC models)
1376+
1377+
|vm-settings-values-dropdown-KVM-list.PNG|
1378+
(KVM disk controllers)
1379+
1380+
1381+
13491382
.. |basic-deployment.png| image:: /_static/images/basic-deployment.png
13501383
:alt: Basic two-machine CloudStack deployment
13511384
.. |VMSnapshotButton.png| image:: /_static/images/VMSnapshotButton.png
@@ -1369,3 +1402,11 @@ CloudStack follows the below sequence of operations to provide GPU/vGPU support
13691402
:alt: depicts adding an iso image
13701403
.. |StopButton.png| image:: /_static/images/stop-instance-icon.png
13711404
:alt: depicts adding an iso image
1405+
.. |vm-settings-dropdown-list.PNG| image:: /_static/images/vm-settings-dropdown-list.PNG
1406+
:alt: List of possible VMware settings
1407+
.. |vm-settings-values-dropdown-list.PNG| image:: /_static/images/vm-settings-values-dropdown-list.PNG
1408+
:alt: List of possible VMware disk controllers
1409+
.. |vm-settings-values1-dropdown-list.PNG| image:: /_static/images/vm-settings-values1-dropdown-list.PNG
1410+
:alt: List of possible VMware NIC models
1411+
.. |vm-settings-values-dropdown-KVM-list.PNG| image:: /_static/images/vm-settings-values-dropdown-KVM-list.PNG
1412+
:alt: List of possible KVM disk controllers

0 commit comments

Comments
 (0)