diff options
Diffstat (limited to 'lib/ansible/plugins/doc_fragments/kubevirt_common_options.py')
| -rw-r--r-- | lib/ansible/plugins/doc_fragments/kubevirt_common_options.py | 132 |
1 files changed, 0 insertions, 132 deletions
diff --git a/lib/ansible/plugins/doc_fragments/kubevirt_common_options.py b/lib/ansible/plugins/doc_fragments/kubevirt_common_options.py deleted file mode 100644 index 7a980e8f73..0000000000 --- a/lib/ansible/plugins/doc_fragments/kubevirt_common_options.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright: (c) 2018, KubeVirt Team <@kubevirt> -# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) - - -class ModuleDocFragment(object): - DOCUMENTATION = r''' -options: - resource_definition: - description: - - "A partial YAML definition of the object being created/updated. Here you can define Kubernetes - resource parameters not covered by this module's parameters." - - "NOTE: I(resource_definition) has lower priority than module parameters. If you try to define e.g. - I(metadata.namespace) here, that value will be ignored and I(namespace) used instead." - aliases: - - definition - - inline - type: dict - wait: - description: - - "I(True) if the module should wait for the resource to get into desired state." - type: bool - default: yes - force: - description: - - If set to C(no), and I(state) is C(present), an existing object will be replaced. - type: bool - default: no - wait_timeout: - description: - - The amount of time in seconds the module should wait for the resource to get into desired state. - type: int - default: 120 - wait_sleep: - description: - - Number of seconds to sleep between checks. - default: 5 - version_added: '2.10' - memory: - description: - - The amount of memory to be requested by virtual machine. - - For example 1024Mi. - type: str - memory_limit: - description: - - The maximum memory to be used by virtual machine. - - For example 1024Mi. - type: str - machine_type: - description: - - QEMU machine type is the actual chipset of the virtual machine. - type: str - merge_type: - description: - - Whether to override the default patch merge approach with a specific type. - - If more than one merge type is given, the merge types will be tried in order. - - "Defaults to C(['strategic-merge', 'merge']), which is ideal for using the same parameters - on resource kinds that combine Custom Resources and built-in resources, as - Custom Resource Definitions typically aren't updatable by the usual strategic merge." - - "See U(https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment)" - type: list - choices: [ json, merge, strategic-merge ] - cpu_shares: - description: - - "Specify CPU shares." - type: int - cpu_limit: - description: - - "Is converted to its millicore value and multiplied by 100. The resulting value is the total amount of CPU time that a container can use - every 100ms. A virtual machine cannot use more than its share of CPU time during this interval." - type: int - cpu_cores: - description: - - "Number of CPU cores." - type: int - cpu_model: - description: - - "CPU model." - - "You can check list of available models here: U(https://github.com/libvirt/libvirt/blob/master/src/cpu_map/index.xml)." - - "I(Note:) User can define default CPU model via as I(default-cpu-model) in I(kubevirt-config) I(ConfigMap), if not set I(host-model) is used." - - "I(Note:) Be sure that node CPU model where you run a VM, has the same or higher CPU family." - - "I(Note:) If CPU model wasn't defined, the VM will have CPU model closest to one that used on the node where the VM is running." - type: str - bootloader: - description: - - "Specify the bootloader of the virtual machine." - - "All virtual machines use BIOS by default for booting." - type: str - smbios_uuid: - description: - - "In order to provide a consistent view on the virtualized hardware for the guest OS, the SMBIOS UUID can be set." - type: str - cpu_features: - description: - - "List of dictionary to fine-tune features provided by the selected CPU model." - - "I(Note): Policy attribute can either be omitted or contain one of the following policies: force, require, optional, disable, forbid." - - "I(Note): In case a policy is omitted for a feature, it will default to require." - - "More information about policies: U(https://libvirt.org/formatdomain.html#elementsCPU)" - type: list - headless: - description: - - "Specify if the virtual machine should have attached a minimal Video and Graphics device configuration." - - "By default a minimal Video and Graphics device configuration will be applied to the VirtualMachineInstance. The video device is vga - compatible and comes with a memory size of 16 MB." - hugepage_size: - description: - - "Specify huge page size." - type: str - tablets: - description: - - "Specify tablets to be used as input devices" - type: list - hostname: - description: - - "Specifies the hostname of the virtual machine. The hostname will be set either by dhcp, cloud-init if configured or virtual machine - name will be used." - version_added: 2.9 - subdomain: - description: - - "If specified, the fully qualified virtual machine hostname will be hostname.subdomain.namespace.svc.cluster_domain. If not specified, - the virtual machine will not have a domain name at all. The DNS entry will resolve to the virtual machine, no matter if the virtual machine - itself can pick up a hostname." - version_added: 2.9 -requirements: - - python >= 2.7 - - openshift >= 0.8.2 -notes: - - "In order to use this module you have to install Openshift Python SDK. - To ensure it's installed with correct version you can create the following task: - I(pip: name=openshift>=0.8.2)" -''' |