Skip to content

Commit

Permalink
Update documentation for strict host tags (#398)
Browse files Browse the repository at this point in the history
* Update documentation for strict host tags

* Address comments
  • Loading branch information
vishesh92 authored Jun 25, 2024
1 parent ed090ab commit a8a7bf4
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
35 changes: 35 additions & 0 deletions source/adminguide/host_and_storage_tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,41 @@ To explain the behavior of host tags, some examples will be demonstrated with tw
* Offering: h3
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.

.. _strict-host-tags:
Strict Host Tags
-----------------
During certain operations, such as changing the compute offering or starting or
live migrating an instance to a specific host, CloudStack may ignore the host
tags. This behavior is intentional and is designed to provide flexibility in
resource allocation. However, in some cases, this can lead to instances being
deployed on undesired hosts.

To address this, CloudStack introduces an add-on feature that allows administrators
to enforce tag checks during these operations. By specifying the required tags
in the global configuration `vm.strict.host.tags`, CloudStack will ensure that
the specified tags must match during the operations. If any of the specified
tags do not match, the operation will fail.

If `resource.limit.host.tags` are defined and
`vm.strict.resource.limit.host.tag.check` is set to true, the tags defined in
`resource.limit.host.tags` are included with the `vm.strict.host.tags`.

.. list-table:: Strict host tags related global settings
:header-rows: 1

* - Parameter
- Default
- Description
* - ``vm.strict.host.tags``
- empty
- A comma-separated list of tags which must match during operations like
modifying the compute offering for an instance, and starting or live
migrating an instance to a specific host.
* - ``vm.strict.resource.limit.host.tag.check``
- `true`
- If set to true, tags specified in `resource.limit.host.tags` are also
included in `vm.strict.host.tags`.

Storage tags
------------
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.
Expand Down
19 changes: 19 additions & 0 deletions source/adminguide/virtual_machines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,14 @@ CloudStack's database. The reboot process does not do this.

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

.. note::
When starting an instance, it's possible to specify a host for deployment,
even if the host's tags don't match the instance's tags. This can lead to a
mismatch between the VM's tags and the host's tags, which may not be
desirable.

To avoid this, refer to the :ref:`strict-host-tags` section


Deleting Instance
------------------
Expand Down Expand Up @@ -441,6 +449,11 @@ Instance, you can change the Instance's compute offering.

#. Click OK.

.. note::
When changing the service offering for an instance, it's possible to have a
mismatch of host tags which can be problematic.

For more information on how to prevent this, see :ref:`strict-host-tags`.

.. _cpu-and-memory-scaling:

Expand Down Expand Up @@ -637,6 +650,12 @@ To manually live migrate an Instance

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

.. note::
During live migration, there can be a mismatch between the instance's tags
with the destination host's tags which might be undesirable.

For more details on how to prevent this, see :ref:`strict-host-tags`.

Moving Instance's Volumes Between Storage Pools (offline volume Migration)
--------------------------------------------------------------------------

Expand Down

0 comments on commit a8a7bf4

Please sign in to comment.