scale_computing.hypercore.version_update_single_node role – Update single-node systems

Note

This role is part of the scale_computing.hypercore collection (version 1.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.version_update_single_node.

Entry point main – Update single-node systems

Synopsis

  • Role version_update_single_node can be use to to update a single-node HyperCore system to a desired HyperCore version.

  • Role performs following steps during version update - shutdown all running VMs, upgrade cluster, start back VMs that were running before upgrade.

Parameters

Parameter

Comments

scale_computing_hypercore_desired_version

string

DEPRECATED, will be removed in release 3.0.0.

Please use version_update_single_node_desired_version instead.

scale_computing_hypercore_shutdown_wait_time

integer

DEPRECATED, will be removed in release 3.0.0.

Please use version_update_single_node_shutdown_wait_time instead.

Default: 300

version_update_single_node_desired_version

string / required

The desired HyperCore version we wish to update to.

If already on desired version, the updates will not be applied.

If there is no desired version present in the list of available updates, no updates will be applied.

If multi-node system was detected, no update will be applied.

version_update_single_node_shutdown_wait_time

integer

How much time (in seconds) VMs have to gracefully shutdown.

After wait time expires a force shutdown is issued. Force shutdown can corrupt VM disk data.

Default: 300

Entry point restart_vms – Start VMs that were running before upgrade

Synopsis

  • Taskfile restart_vms is used start VMs that were running before upgrade.

  • Input is a list of VMs, as returned by scale_computing.hypercore.vm_info module. The VMs listed as `running` in the list are then started.

Parameters

Parameter

Comments

scale_computing_hypercore_restart_vms

dictionary

DEPRECATED, will be removed in release 3.0.0.

Please use version_update_single_node_restart_vms instead.

version_update_single_node_restart_vms

dictionary / required

VM list as returned by scale_computing.hypercore.vm_info module.

Entry point shutdown_vms – Shutdown running VMs before upgrade

Synopsis

  • Taskfile shutdown_vms is used to shutdown running VMs.

  • Input is a list of VMs, as returned by scale_computing.hypercore.vm_info module. The VMs listed as `running` in the list are then shutdown.

Parameters

Parameter

Comments

scale_computing_hypercore_shutdown_tags

list / elements=string

DEPRECATED, will be removed in release 3.0.0.

Please use version_update_single_node_shutdown_tags instead.

Default: []

scale_computing_hypercore_shutdown_vms

dictionary

DEPRECATED, will be removed in release 3.0.0.

Please use version_update_single_node_shutdown_vms instead.

scale_computing_hypercore_shutdown_wait_time

integer

DEPRECATED, will be removed in release 3.0.0.

Please use version_update_single_node_shutdown_wait_time instead.

Default: 300

version_update_single_node_shutdown_tags

list / elements=string

VM will be shutdown only if it has assigned (at least one) tag from this list.

If tag list is empty, than every running VM from the VM list is shutdown.

Default: []

version_update_single_node_shutdown_vms

dictionary / required

VM list as returned by scale_computing.hypercore.vm_info module.

version_update_single_node_shutdown_wait_time

integer

How much time (in seconds) VMs have to gracefully shutdown.

After wait time expires a force shutdown is issued. Force shutdown can corrupt VM disk data.

Default: 300