Skip to content

Commit

Permalink
Improving the "ovirt_disk" documentation.
Browse files Browse the repository at this point in the history 
On case of multiple disks with the same name, a few extra parameter(s)
need to be provided to identify the correct disk.
1) "vm_name" / "vm_id" if the disk is attached to a VM and there
is no any other disk with the same name attached to the same VM.
2) A disk "id", which is the best possible option.

Signed-off-by: Pavel Bar <[email protected]>
Bug-Url: https://bugzilla.redhat.com/2016638
  • Loading branch information
@barpavel
barpavel committed Jul 11, 2022
1 parent b6bdb42 commit 4f62d41
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
1 change: 1 addition & 0 deletions plugins/modules/ovirt_disk.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
- "Size of the disk. Size should be specified using IEC standard units.
For example 10GiB, 1024MiB, etc."
- "Size can be only increased, not decreased."
- If there are multiple disks with the same name, provide C(vm_name)/C(vm_id) and/or disk C(id) to uniquely identify the intended disk.
type: str
interface:
description:
Expand Down
26 changes: 13 additions & 13 deletions roles/disaster_recovery/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ The `disaster_recovery` role responsible to manage the disaster recovery scenari
Role Variables
--------------

| Name | Default value | |
|-------------------------|-----------------------|-----------------------------------------------------|
| dr_ignore_error_clean | False | Specify whether to ignore errors on clean engine setup.<br/>This is mainly being used to avoid failures when trying to move a storage domain to maintenance/detach it. |
| dr_ignore_error_recover | True | Specify whether to ignore errors on recover. |
| dr_partial_import | True | Specify whether to use the partial import flag on VM/Template register.<br/>If True, VMs and Templates will be registered without any missing disks, if false VMs/Templates will fail to be registered in case some of their disks will be missing from any of the storage domains. |
| dr_target_host | secondary | Specify the default target host to be used in the ansible play.<br/> This host indicates the target site which the recover process will be done. |
| dr_source_map | primary | Specify the default source map to be used in the play.<br/> The source map indicates the key which is used to get the target value for each attribute which we want to register with the VM/Template. |
| dr_reset_mac_pool | True | If True, then once a VM will be registered, it will automatically reset the mac pool, if configured in the VM. |
| dr_cleanup_retries_maintenance | 3 | Specify the number of retries of moving a storage domain to maintenance VM as part of a fail back scenario. |
| dr_cleanup_delay_maintenance | 120 | Specify the number of seconds between each retry as part of a fail back scenario. |
| dr_clean_orphaned_vms | True | Specify whether to remove any VMs which have no disks from the setup as part of cleanup. |
| dr_clean_orphaned_disks | True | Specify whether to remove lun disks from the setup as part of engine setup. |
| dr_running_vms | /tmp/ovirt_dr_running_vm_list | Specify the file path which is used to contain the data of the running VMs in the secondary setup before the failback process run on the primary setup after the secondary site cleanup was finished. Note that the /tmp folder is being used as default so the file will not be available after system reboot.
| Name | Default value | |
|--------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| dr_ignore_error_clean | `False` | Specify whether to ignore errors on clean engine setup.<br/>This is mainly being used to avoid failures when trying to move a storage domain to maintenance/detach it. |
| dr_ignore_error_recover | `True` | Specify whether to ignore errors on recover. |
| dr_partial_import | `True` | Specify whether to use the partial import flag on VM/Template register.<br/>If `True`, VMs and Templates will be registered without any missing disks, if false VMs/Templates will fail to be registered in case some of their disks will be missing from any of the storage domains. |
| dr_target_host | `secondary` | Specify the default target host to be used in the ansible play.<br/> This host indicates the target site which the recover process will be done. |
| dr_source_map | `primary` | Specify the default source map to be used in the play.<br/> The source map indicates the key which is used to get the target value for each attribute which we want to register with the VM/Template. |
| dr_reset_mac_pool | `True` | If `True`, then once a VM will be registered, it will automatically reset the mac pool, if configured in the VM. |
| dr_cleanup_retries_maintenance | `3` | Specify the number of retries of moving a storage domain to maintenance VM as part of a fail back scenario. |
| dr_cleanup_delay_maintenance | `120` | Specify the number of seconds between each retry as part of a fail back scenario. |
| dr_clean_orphaned_vms | `True` | Specify whether to remove any VMs which have no disks from the setup as part of cleanup. |
| dr_clean_orphaned_disks | `True` | Specify whether to remove lun disks from the setup as part of engine setup. |
| dr_running_vms | `/tmp/ovirt_dr_running_vm_list` | Specify the file path which is used to contain the data of the running VMs in the secondary setup before the failback process run on the primary setup after the secondary site cleanup was finished. Note that the /tmp folder is being used as default so the file will not be available after system reboot. |


Example Playbook
Expand Down

0 comments on commit 4f62d41

Please sign in to comment.