Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvments of oVirt modules #19668

Merged
merged 1 commit into from
Dec 30, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/ansible/modules/cloud/ovirt/ovirt_affinity_labels.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
DOCUMENTATION = '''
---
module: ovirt_affinity_labels
short_description: Module to affinity labels in oVirt
short_description: Module to manage affinity labels in oVirt
version_added: "2.3"
author: "Ondra Machacek (@machacekondra)"
description:
Expand Down Expand Up @@ -103,7 +103,7 @@
returned: On success if affinity label is found.
type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
template:
affinity_label:
description: "Dictionary of all the affinity label attributes. Affinity label attributes can be found on your oVirt instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_label."
returned: On success if affinity label is found.
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/ovirt/ovirt_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
DOCUMENTATION = '''
---
module: ovirt_auth
short_description: "Module to manage authentication to oVirt."
short_description: "Module to manage authentication to oVirt"
author: "Ondra Machacek (@machacekondra)"
version_added: "2.2"
description:
Expand Down
28 changes: 14 additions & 14 deletions lib/ansible/modules/cloud/ovirt/ovirt_clusters.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,44 +73,44 @@
- "Management network of cluster to access cluster hosts."
ballooning:
description:
- "If (True) enable memory balloon optimization. Memory balloon is used to
- "If I(True) enable memory balloon optimization. Memory balloon is used to
re-distribute / reclaim the host memory based on VM needs
in a dynamic way."
virt:
description:
- "If (True), hosts in this cluster will be used to run virtual machines."
- "If I(True), hosts in this cluster will be used to run virtual machines."
gluster:
description:
- "If (True), hosts in this cluster will be used as Gluster Storage
- "If I(True), hosts in this cluster will be used as Gluster Storage
server nodes, and not for running virtual machines."
- "By default the cluster is created for virtual machine hosts."
threads_as_cores:
description:
- "If (True) the exposed host threads would be treated as cores
- "If I(True) the exposed host threads would be treated as cores
which can be utilized by virtual machines."
ksm:
description:
- "I (True) MoM enables to run Kernel Same-page Merging (KSM) when
- "I I(True) MoM enables to run Kernel Same-page Merging I(KSM) when
necessary and when it can yield a memory saving benefit that
outweighs its CPU cost."
ksm_numa:
description:
- "If (True) enables KSM C(ksm) for best berformance inside NUMA nodes."
- "If I(True) enables KSM C(ksm) for best berformance inside NUMA nodes."
ha_reservation:
description:
- "If (True) enable the oVirt to monitor cluster capacity for highly
- "If I(True) enable the oVirt to monitor cluster capacity for highly
available virtual machines."
trusted_service:
description:
- "If (True) enable integration with an OpenAttestation server."
vm_reason:
description:
- "If (True) enable an optional reason field when a virtual machine
- "If I(True) enable an optional reason field when a virtual machine
is shut down from the Manager, allowing the administrator to
provide an explanation for the maintenance."
host_reason:
description:
- "If (True) enable an optional reason field when a host is placed
- "If I(True) enable an optional reason field when a host is placed
into maintenance mode from the Manager, allowing the administrator
to provide an explanation for the maintenance."
memory_policy:
Expand All @@ -129,15 +129,15 @@
- "The address must be in the following format: I(protocol://[host]:[port])"
fence_enabled:
description:
- "If (True) enables fencing on the cluster."
- "If I(True) enables fencing on the cluster."
- "Fencing is enabled by default."
fence_skip_if_sd_active:
description:
- "If (True) any hosts in the cluster that are Non Responsive
- "If I(True) any hosts in the cluster that are Non Responsive
and still connected to storage will not be fenced."
fence_skip_if_connectivity_broken:
description:
- "If (True) fencing will be temporarily disabled if the percentage
- "If I(True) fencing will be temporarily disabled if the percentage
of hosts in the cluster that are experiencing connectivity issues
is greater than or equal to the defined threshold."
- "The threshold can be specified by C(fence_connectivity_threshold)."
Expand Down Expand Up @@ -166,7 +166,7 @@
- "This parameter is used only when C(migration_bandwidth) is I(custom)."
migration_auto_converge:
description:
- "If (True) auto-convergence is used during live migration of virtual machines."
- "If I(True) auto-convergence is used during live migration of virtual machines."
- "Used only when C(migration_policy) is set to I(legacy)."
- "Following options are supported:"
- "C(true) - Override the global setting to I(true)."
Expand All @@ -175,7 +175,7 @@
choices: ['true', 'false', 'inherit']
migration_compressed:
description:
- "If (True) compression is used during live migration of the virtual machine."
- "If I(True) compression is used during live migration of the virtual machine."
- "Used only when C(migration_policy) is set to I(legacy)."
- "Following options are supported:"
- "C(true) - Override the global setting to I(true)."
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/ovirt/ovirt_disks.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
DOCUMENTATION = '''
---
module: ovirt_disks
short_description: "Module to manage Virtual Machine and floating disks in oVirt."
short_description: "Module to manage Virtual Machine and floating disks in oVirt"
version_added: "2.2"
author: "Ondra Machacek (@machacekondra)"
description:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@
DOCUMENTATION = '''
---
module: ovirt_external_providers_facts
short_description: Retrieve facts about one or more oVirt external_providers
short_description: Retrieve facts about one or more oVirt external providers
version_added: "2.3"
description:
- "Retrieve facts about one or more oVirt external_providers."
- "Retrieve facts about one or more oVirt external providers."
notes:
- "This module creates a new top-level C(ovirt_external_providers) fact, which
contains a list of external_providers."
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/ovirt/ovirt_hosts_facts.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
check_sdk,
create_connection,
get_dict_of_struct,
ovirt_full_argument_spec,
ovirt_facts_full_argument_spec,
)


Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/cloud/ovirt/ovirt_storage_domains.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
glusterfs:
description:
- "Dictionary with values for GlusterFS storage type:"
- "C(address) - Address of the NFS server. E.g.: myserver.mydomain.com"
- "C(address) - Address of the Gluster server. E.g.: myserver.mydomain.com"
- "C(path) - Path of the mount point. E.g.: /path/to/my/data"
- "C(mount_options) - Option which will be passed when mounting storage."
- "Note that these parameters are not idempotent."
Expand Down Expand Up @@ -187,7 +187,7 @@
returned: On success if storage domain is found.
type: str
sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
storage domain:
storage_domain:
description: "Dictionary of all the storage domain attributes. Storage domain attributes can be found on your oVirt instance
at following url: https://ovirt.example.com/ovirt-engine/api/model#types/storage_domain."
returned: On success if storage domain is found.
Expand Down
2 changes: 1 addition & 1 deletion lib/ansible/modules/cloud/ovirt/ovirt_vms.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
DOCUMENTATION = '''
---
module: ovirt_vms
short_description: "Module to manage Virtual Machines in oVirt."
short_description: "Module to manage Virtual Machines in oVirt"
version_added: "2.2"
author: "Ondra Machacek (@machacekondra)"
description:
Expand Down