kubevirt_rs – Manage KubeVirt virtual machine replica sets

From Get docs
Ansible/docs/2.8/modules/kubevirt rs module


kubevirt_rs – Manage KubeVirt virtual machine replica sets

New in version 2.8.


Synopsis

  • Use Openshift Python SDK to manage the state of KubeVirt virtual machine replica sets.

Requirements

The below requirements are needed on the host that executes this module.

  • openshift >= 0.8.2
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments

api_key

string

Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.

bootloader

string

Specify the bootloader of the virtual machine.

All virtual machines use BIOS by default for booting.

ca_cert

path

Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.


aliases: ssl_ca_cert

client_cert

path

Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.


aliases: cert_file

client_key

path

Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.


aliases: key_file

cloud_init_nocloud

dictionary

Represents a cloud-init NoCloud user-data source. The NoCloud data will be added as a disk to the virtual machine. A proper cloud-init installation is required inside the guest. More information https://kubevirt.io/api-reference/master/definitions.html#_v1_cloudinitnocloudsource

context

string

The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.

cpu_cores

integer

Number of CPU cores.

cpu_features

list

List of dictionary to fine-tune features provided by the selected CPU model.

Note: Policy attribute can either be omitted or contain one of the following policies: force, require, optional, disable, forbid.

Note: In case a policy is omitted for a feature, it will default to require.

More information about policies: https://libvirt.org/formatdomain.html#elementsCPU

cpu_limit

integer

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.

cpu_model

string

CPU model.

You can check list of available models here: https://github.com/libvirt/libvirt/blob/master/src/cpu_map/index.xml.

Note: User can define default CPU model via as default-cpu-model in kubevirt-config ConfigMap, if not set host-model is used.

Note: Be sure that node CPU model where you run a VM, has the same or higher CPU family.

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.

cpu_shares

integer

Specify CPU shares.

disks

list

List of dictionaries which specify disks of the virtual machine.

A disk can be made accessible via four different types: disk, lun, cdrom, floppy.

All possible configuration options are available in https://kubevirt.io/api-reference/master/definitions.html#_v1_disk

Each disk must have specified a volume that declares which volume type of the disk All possible configuration options of volume are available in https://kubevirt.io/api-reference/master/definitions.html#_v1_volume.

force

boolean

  • no

  • yes

If set to no, and state is present, an existing object will be replaced.

headless

-

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.

host

string

Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.

hugepage_size

string

Specify huge page size.

interfaces

list

An interface defines a virtual network interface of a virtual machine (also called a frontend).

All possible configuration options interfaces are available in https://kubevirt.io/api-reference/master/definitions.html#_v1_interface

Each interface must have specified a network that declares which logical or physical device it is connected to (also called as backend). All possible configuration options of network are available in https://kubevirt.io/api-reference/master/definitions.html#_v1_network.

kubeconfig

path

Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.

labels

dictionary

Labels are key/value pairs that are attached to virtual machines. Labels are intended to be used to specify identifying attributes of virtual machines that are meaningful and relevant to users, but do not directly imply semantics to the core system. Labels can be used to organize and to select subsets of virtual machines. Labels can be attached to virtual machines at creation time and subsequently added and modified at any time.

More on labels that are used for internal implementation https://kubevirt.io/user-guide/#/misc/annotations_and_labels

machine_type

string

QEMU machine type is the actual chipset of the virtual machine.

memory

string

The amount of memory to be requested by virtual machine.

For example 1024Mi.

memory_limit

string

The maximum memory to be used by virtual machine.

For example 1024Mi.

merge_type

list

  • json
  • merge
  • strategic-merge

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 ['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.

name

string / required

Name of the virtual machine replica set.

namespace

string / required

Namespace where the virtual machine replica set exists.

password

string

Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.

Please read the description of the username option for a discussion of when this option is applicable.

replicas

integer

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified.

Replicas defaults to 1 if newly created replica set.

resource_definition

dictionary

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: resource_definition has lower priority than module parameters. If you try to define e.g. metadata.namespace here, that value will be ignored and namespace used instead.


aliases: definition, inline

selector

dictionary / required

Selector is a label query over a set of virtual machine.

smbios_uuid

string

In order to provide a consistent view on the virtualized hardware for the guest OS, the SMBIOS UUID can be set.

state

string

  • present

  • absent

Create or delete virtual machine replica sets.

tablets

list

Specify tablets to be used as input devices

username

string

Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.

Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the k8s_auth module, as that might do what you need.

validate_certs

boolean

  • no
  • yes

Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.


aliases: verify_ssl

wait

boolean

  • no
  • yes

True if the module should wait for the resource to get into desired state.

wait_timeout

integer

Default:

120

The amount of time in seconds the module should wait for the resource to get into desired state.



Notes

Note

  • The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python
  • To avoid SSL certificate validation errors when validate_certs is True, the full certificate chain for the API server must be provided via ca_cert or in the kubeconfig file.
  • 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: pip: name=openshift>=0.8.2


Examples

- name: Create virtual machine replica set 'myvmir'
  kubevirt_rs:
      state: present
      name: myvmir
      namespace: vms
      wait: true
      replicas: 3
      memory: 64M
      labels:
        myvmi: myvmi
      selector:
        matchLabels:
            myvmi: myvmi
      disks:
         - name: containerdisk
           volume:
             containerDisk:
               image: kubevirt/cirros-container-disk-demo:latest
               path: /custom-disk/cirros.img
           disk:
             bus: virtio

- name: Remove virtual machine replica set 'myvmir'
  kubevirt_rs:
      state: absent
      name: myvmir
      namespace: vms
      wait: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

kubevirt_rs

complex

success

The virtual machine virtual machine replica set managed by the user.

This dictionary contains all values returned by the KubeVirt API all options are described here https://kubevirt.io/api-reference/master/definitions.html#_v1_virtualmachineinstance





Status

Authors

  • KubeVirt Team (@kubevirt)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/kubevirt_rs_module.html