Skip to content

Commit 9dff7ce

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

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

source/adminguide/host_and_storage_tags.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,37 @@ 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, like changing compute offering, and starting or live
56+
migrating an instance to a specific host, CloudStack will ignore the host tags,
57+
which can lead to issues where a instance starts on an undesired host.
58+
59+
To avoid a mismatch of tags, tags which must always match during any operation
60+
can be defined in `vm.strict.host.tags`. If the tags which doesn't match are
61+
also part of `vm.strict.host.tags`, the operation will fail.
62+
63+
If `resource.limit.host.tags` are defined and
64+
`vm.strict.resource.limit.host.tag.check` is set to true, the tags defined in
65+
`resource.limit.host.tags` are included with the `vm.strict.host.tags`.
66+
67+
.. list-table:: Strict host tags related global settings
68+
:header-rows: 1
69+
70+
* - Parameter
71+
- Default
72+
- Description
73+
* - ``vm.strict.host.tags``
74+
- empty
75+
- A comma-separated list of tags which must match during operations like
76+
modifying the compute offering for an instance, and starting or live
77+
migrating an instance to a specific host.
78+
* - ``vm.strict.resource.limit.host.tag.check``
79+
- `true`
80+
- If set to true, tags specified in `resource.limit.host.tags` are also
81+
included in `vm.strict.host.tags`.
82+
5283
Storage tags
5384
------------
5485
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: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,14 @@ 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+
When starting an instance, it's possible to specify a host for deployment,
281+
even if the host's tags don't match the instance's tags. This can lead to a
282+
mismatch between the VM's tags and the host's tags, which may not be
283+
desirable.
284+
285+
To avoid this, refer to the :ref:`strict-host-tags` section
286+
279287

280288
Deleting Instance
281289
------------------
@@ -441,6 +449,11 @@ Instance, you can change the Instance's compute offering.
441449

442450
#. Click OK.
443451

452+
.. note::
453+
When changing the service offering for an instance, it's possible to have a
454+
mismatch of host tags which can be problematic.
455+
456+
For more information on how to prevent this, see :ref:`strict-host-tags`.
444457

445458
.. _cpu-and-memory-scaling:
446459

@@ -637,6 +650,12 @@ To manually live migrate an Instance
637650

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

653+
.. note::
654+
During live migration, there can be a mismatch between the instance's tags
655+
with the destination host's tags which might be undesirable.
656+
657+
For more details on how to prevent this, see :ref:`strict-host-tags`.
658+
640659
Moving Instance's Volumes Between Storage Pools (offline volume Migration)
641660
--------------------------------------------------------------------------
642661

0 commit comments

Comments
 (0)