Skip to content

Commit a8a7bf4

Browse files
authored
Update documentation for strict host tags (#398)
* Update documentation for strict host tags * Address comments
1 parent ed090ab commit a8a7bf4

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

source/adminguide/host_and_storage_tags.rst

+35
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,41 @@ To explain the behavior of host tags, some examples will be demonstrated with tw
5454
* Offering: h3
5555
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.
5656

57+
.. _strict-host-tags:
58+
Strict Host Tags
59+
-----------------
60+
During certain operations, such as changing the compute offering or starting or
61+
live migrating an instance to a specific host, CloudStack may ignore the host
62+
tags. This behavior is intentional and is designed to provide flexibility in
63+
resource allocation. However, in some cases, this can lead to instances being
64+
deployed on undesired hosts.
65+
66+
To address this, CloudStack introduces an add-on feature that allows administrators
67+
to enforce tag checks during these operations. By specifying the required tags
68+
in the global configuration `vm.strict.host.tags`, CloudStack will ensure that
69+
the specified tags must match during the operations. If any of the specified
70+
tags do not match, the operation will fail.
71+
72+
If `resource.limit.host.tags` are defined and
73+
`vm.strict.resource.limit.host.tag.check` is set to true, the tags defined in
74+
`resource.limit.host.tags` are included with the `vm.strict.host.tags`.
75+
76+
.. list-table:: Strict host tags related global settings
77+
:header-rows: 1
78+
79+
* - Parameter
80+
- Default
81+
- Description
82+
* - ``vm.strict.host.tags``
83+
- empty
84+
- A comma-separated list of tags which must match during operations like
85+
modifying the compute offering for an instance, and starting or live
86+
migrating an instance to a specific host.
87+
* - ``vm.strict.resource.limit.host.tag.check``
88+
- `true`
89+
- If set to true, tags specified in `resource.limit.host.tags` are also
90+
included in `vm.strict.host.tags`.
91+
5792
Storage tags
5893
------------
5994
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

+19
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)