Skip to content

Commit c5e4ae9

Browse files
committed
Update documentation for strict host tags
1 parent fd50cb8 commit c5e4ae9

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

source/adminguide/host_and_storage_tags.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,35 @@ To explain the behavior of host tags, some examples will be demonstrated with tw
4949
* Offering: h3
5050
None of the hosts have compatible tags and it will not be possible to deploy a VM with the offering. However, CloudStack ignores this behavior when a host is manually selected.
5151

52+
.. _strict-host-tags:
53+
Strict Host Tags
54+
-----------------
55+
During certain operations, such as VM deployment, changing compute offering and live migration,
56+
CloudStack will ignore the host tags if a host is specified. This can result in issues in which
57+
a VM is deployed on an undesired host.
58+
59+
This behavior can be changed by setting the `vm.strict.host.tags` to the list of tags which
60+
should match with the host. While performing the operations where a mismatch of tags can occur,
61+
CloudStack will fail the operation if the host tags do not match with the tags specified
62+
in `vm.strict.host.tags`.
63+
64+
If `resource.limit.host.tags` is defined and `vm.strict.resource.limit.host.tag.check` is set to
65+
`true`, the host tags will be checked against the tags specified in `vm.strict.host.tags` as
66+
well as the `resource.limit.host.tags`.
67+
68+
.. list-table:: Strict host tags related global settings
69+
:header-rows: 1
70+
71+
* - Parameter
72+
- Default
73+
- Description
74+
* - ``vm.strict.host.tags``
75+
- empty
76+
- A comma-separated list of tags for strict host checking while performing operations like VM deployment, changing compute offering, and live migration.
77+
* - ``vm.strict.resource.limit.host.tag.check``
78+
- `true`
79+
- If set to true, `resource.limit.host.tags` are also included in the strict host tag check.
80+
5281
Storage tags
5382
------------
5483
Storage tags are responsible for directing volumes to compatible primary storage. They are validated with the storage tags entered in the disk offerings or system offerings.

source/adminguide/virtual_machines.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,12 @@ CloudStack's database. The reboot process does not do this.
276276

277277
When starting an Instance, admin Users have the option to specify a pod, cluster, or host.
278278

279+
.. note::
280+
If a host is specified while starting an Instance, the Instance will be deployed on the
281+
specified host even if the host's tags do not match the Instance's tags. This can lead to
282+
a mismatch of VM's tags with the host's tags which might be undesirable.
283+
284+
For more details on how to prevent this, see :ref:`strict-host-tags`.
279285

280286
Deleting Instance
281287
------------------
@@ -441,6 +447,10 @@ Instance, you can change the Instance's compute offering.
441447

442448
#. Click OK.
443449

450+
.. note::
451+
It's possible to have a mismatch of host tags on changing the service offering which might be undesirable.
452+
453+
For more details on how to prevent this, see :ref:`strict-host-tags`.
444454

445455
.. _cpu-and-memory-scaling:
446456

@@ -637,6 +647,11 @@ To manually live migrate an Instance
637647

638648
where i in [0,..,N] and N = number of volumes of the Instance
639649

650+
.. note::
651+
There can be a mismatch of VM's tags with the destination host's tags which might be undesirable.
652+
653+
For more details on how to prevent this, see :ref:`strict-host-tags`.
654+
640655
Moving Instance's Volumes Between Storage Pools (offline volume Migration)
641656
--------------------------------------------------------------------------
642657

0 commit comments

Comments
 (0)