internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-05-06 13:22:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve docs by adding markup

Browse Source 
Improve the generated documentations by adding Ansible documentation markup
where appropriate.

Signed-off-by: Felix Matouschek <fmatouschek@redhat.com>
This commit is contained in:
Felix Matouschek
2024-05-07 14:51:13 +02:00
parent 0fd9f625ee
commit 4851e5d20d
3 changed files with 71 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
plugins/modules/kubevirt_vm.py
View File

@@ -35,72 +35,72 @@ options:
default: kubevirt.io/v1
name:
description:
- Specify the name of the VirtualMachine.
- This option is ignored when I(state) is not set to C(present).
- mutually exclusive with C(generate_name).
- Specify the name of the C(VirtualMachine).
- This option is ignored when O(state=present) is not set.
- Mutually exclusive with O(generate_name).
type: str
generate_name:
description:
- Specify the basis of the VirtualMachine name and random characters will be added automatically on server to
- Specify the basis of the C(VirtualMachine) name and random characters will be added automatically on the cluster to
generate a unique name.
- Only used when I(state=present).
- mutually exclusive with C(name).
- Only used when O(state=present).
- Mutually exclusive with O(name).
type: str
namespace:
description:
- Specify the namespace of the VirtualMachine.
- Specify the namespace of the C(VirtualMachine).
type: str
required: yes
annotations:
description:
- Specify annotations to set on the VirtualMachine.
- Only used when I(state=present).
- Specify annotations to set on the C(VirtualMachine).
- Only used when O(state=present).
type: dict
labels:
description:
- Specify labels to set on the VirtualMachine.
- Specify labels to set on the C(VirtualMachine).
type: dict
running:
description:
- Specify whether the VirtualMachine should be running.
- Specify whether the C(VirtualMachine) should be running or not.
type: bool
default: yes
instancetype:
description:
- Specify the instancetype matcher of the VirtualMachine.
- Only used when I(state=present).
- Specify the C(Instancetype) matcher of the C(VirtualMachine).
- Only used when O(state=present).
type: dict
preference:
description:
- Specify the preference matcher of the VirtualMachine.
- Only used when I(state=present).
- Specify the C(Preference) matcher of the C(VirtualMachine).
- Only used when O(state=present).
type: dict
data_volume_templates:
description:
- Specify the DataVolume templates of the VirtualMachine.
- 'See: https://kubevirt.io/api-reference/main/definitions.html#_v1_datavolumetemplatespec'
- Specify the C(DataVolume) templates of the C(VirtualMachine).
- See U(https://kubevirt.io/api-reference/main/definitions.html#_v1_datavolumetemplatespec)
type: list
elements: 'dict'
spec:
description:
- Specify the template spec of the VirtualMachine.
- 'See: https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec'
- Specify the template spec of the C(VirtualMachine).
- See U(https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec)
type: dict
wait:
description:
- Whether to wait for the VirtualMachine to end up in the ready state.
- Whether to wait for the C(VirtualMachine) to end up in the ready state.
type: bool
default: no
wait_sleep:
description:
- Number of seconds to sleep between checks.
- Ignored if C(wait) is not set.
- Ignored if O(wait) is not set.
default: 5
type: int
wait_timeout:
description:
- How long in seconds to wait for the resource to end up in the desired state.
- Ignored if C(wait) is not set.
- How long in seconds to wait for the resource to end up in the ready state.
- Ignored if O(wait) is not set.
default: 120
type: int
@@ -205,12 +205,12 @@ result:
returned: success
contains:
changed:
description: Whether the VirtualMachine was changed
description: Whether the C(VirtualMachine) was changed or not.
type: bool
sample: True
duration:
description: elapsed time of task in seconds
returned: when C(wait) is true
description: Elapsed time of the task in seconds.
returned: When O(wait=true).
type: int
sample: 48
method:

38
plugins/modules/kubevirt_vm_info.py
View File

@@ -17,8 +17,8 @@ author:
- "KubeVirt.io Project (!UNKNOWN)"
description:
- Use the Kubernetes Python client to perform read operations on KubeVirt VirtualMachines.
- Pass options to find VirtualMachines as module arguments.
- Use the Kubernetes Python client to perform read operations on KubeVirt C(VirtualMachines).
- Pass options to find C(VirtualMachines) as module arguments.
- Authenticate using either a config file, certificates, password or token.
- Supports check mode.
@@ -30,45 +30,45 @@ options:
default: kubevirt.io/v1
name:
description:
- Specify the name of the VirtualMachine.
- Specify the name of the C(VirtualMachine).
type: str
namespace:
description:
- Specify the namespace of VirtualMachines.
- Specify the namespace of C(VirtualMachines).
type: str
label_selectors:
description: List of label selectors to use to filter results
description: List of label selectors to use to filter results.
type: list
elements: str
default: []
field_selectors:
description: List of field selectors to use to filter results
description: List of field selectors to use to filter results.
type: list
elements: str
default: []
running:
description:
- Specify whether the VirtualMachine should be running.
- Specify whether the C(VirtualMachine) should be running or not.
- This affects the ready condition to wait for.
- This requires C(wait) and is only used when I(wait=yes).
- This requires O(wait=yes).
type: bool
version_added: 1.4.0
wait:
description:
- Whether to wait for the VirtualMachine to end up in the ready state.
- By default this is waiting for the VirtualMachine to be up and running.
- Modify this behavior by setting C(running).
- Whether to wait for the C(VirtualMachine) to end up in the ready state.
- By default this is waiting for the C(VirtualMachine) to be up and running.
- Modify this behavior by setting O(running).
type: bool
wait_sleep:
description:
- Number of seconds to sleep between checks.
- Ignored if C(wait) is not set.
- Ignored if O(wait) is not set.
default: 5
type: int
wait_timeout:
description:
- How long in seconds to wait for the resource to end up in the desired state.
- Ignored if C(wait) is not set.
- How long in seconds to wait for the resource to end up in the ready state.
- Ignored if O(wait) is not set.
default: 120
type: int
@@ -119,12 +119,12 @@ EXAMPLES = """
RETURN = """
api_found:
description:
- Whether the specified api_version and VirtualMachine kind were successfully mapped to an existing API on the targeted cluster.
- Whether the specified O(api_version) and C(VirtualMachine) C(Kind) were successfully mapped to an existing API on the target cluster.
returned: always
type: bool
resources:
description:
- The VirtualMachine(s) that exist(s)
- The C(VirtualMachines) that exist.
returned: success
type: complex
contains:
@@ -133,7 +133,7 @@ resources:
returned: success
type: str
kind:
description: Represents the REST resource this object represents.
description: Represents the C(REST) resource this object represents.
returned: success
type: str
metadata:
@@ -141,11 +141,11 @@ resources:
returned: success
type: dict
spec:
description: Specific attributes of the VirtualMachine. Can vary based on the I(api_version).
description: Specific attributes of the C(VirtualMachine). Can vary based on the O(api_version).
returned: success
type: dict
status:
description: Current status details for the VirtualMachine.
description: Current status details for the C(VirtualMachine).
returned: success
type: dict
"""