community.kubevirt.kubevirt – KubeVirt inventory source

Note

This plugin is part of the community.kubevirt collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.kubevirt.

To use it in a playbook, specify: community.kubevirt.kubevirt.

Synopsis

  • Fetch running VirtualMachines for one or more namespaces.

  • Groups by namespace, namespace_vms and labels.

  • Uses kubevirt.(yml|yaml) YAML configuration file to set parameter values.

Requirements

The below requirements are needed on the local controller node that executes this inventory.

  • openshift >= 0.6

  • PyYAML >= 3.11

Parameters

Parameter

Comments

cache

boolean

Toggle to enable/disable the caching of the inventory’s source data, requires a cache plugin setup to work.

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory]
cache = no

  • Environment variable: ANSIBLE_INVENTORY_CACHE

cache_connection

string

Cache connection data or path, read cache plugin documentation for specifics.

Configuration:

  • INI entries:

    [defaults]
fact_caching_connection = None

    [inventory]
cache_connection = None

  • Environment variable: ANSIBLE_CACHE_PLUGIN_CONNECTION

  • Environment variable: ANSIBLE_INVENTORY_CACHE_CONNECTION

cache_plugin

string

Cache plugin to use for the inventory’s source data.

Default: “memory”

Configuration:

  • INI entries:

    [defaults]
fact_caching = memory

    [inventory]
cache_plugin = memory

  • Environment variable: ANSIBLE_CACHE_PLUGIN

  • Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN

cache_prefix

string

Prefix to use for cache plugin files/tables

Default: “ansible_inventory_”

Configuration:

  • INI entries:

    [default]
fact_caching_prefix = ansible_inventory_

    [inventory]
cache_prefix = ansible_inventory_

  • Environment variable: ANSIBLE_CACHE_PLUGIN_PREFIX

  • Environment variable: ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX

cache_timeout

integer

Cache duration in seconds

Default: 3600

Configuration:

  • INI entries:

    [defaults]
fact_caching_timeout = 3600

    [inventory]
cache_timeout = 3600

  • Environment variable: ANSIBLE_CACHE_PLUGIN_TIMEOUT

  • Environment variable: ANSIBLE_INVENTORY_CACHE_TIMEOUT

compose

dictionary

Create vars from jinja2 expressions.

Default: {}

connections

list / elements=string

Optional list of cluster connection settings. If no connections are provided, the default ~/.kube/config and active context will be used, and objects will be returned for all namespaces the active user is authorized to access.

annotation_variable

string

Specify the name of the annotation which provides data, which should be used as inventory host variables.

Note, that the value in ansible annotations should be json.

Default: “ansible”

api_key

string

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

api_version

string

Specify the KubeVirt API version.

cert_file

string

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

context

string

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

host

string

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

key_file

string

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

kubeconfig

string

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.

name

string

Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.

namespaces

list / elements=string

List of namespaces. If not specified, will fetch all virtual machines for all namespaces user is authorized to access.

network_name

aliases: interface_name

string

In case of multiple network attached to virtual machine, define which interface should be returned as primary IP address.

password

string

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

ssl_ca_cert

string

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

username

string

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

verify_ssl

boolean

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

Choices:

  • no

  • yes

groups

dictionary

Add hosts to group based on Jinja2 conditionals.

Default: {}

host_format

string

Specify the format of the host in the inventory group.

Default: “{namespace}-{name}-{uid}”

keyed_groups

list / elements=string

Add hosts to group based on the values of a variable.

Default: []

leading_separator

boolean

added in 2.11 of ansible.builtin

Use in conjunction with keyed_groups.

By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.

This is because the default prefix is “” and the default separator is “_”.

Set this option to False to omit the leading underscore (or other separator) if no prefix is given.

If the group name is derived from a mapping the separator is still used to concatenate the items.

To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.

Choices:

  • no

  • yes ← (default)

plugin

string / required

token that ensures this is a source file for the ‘kubevirt’ plugin.

Choices:

  • kubevirt

  • community.general.kubevirt

  • community.kubevirt.kubevirt

strict

boolean

If yes make invalid entries a fatal error, otherwise skip and continue.

Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.

Choices:

  • no ← (default)

  • yes

use_extra_vars

boolean

added in 2.11 of ansible.builtin

Merge extra vars into the available variables for composition (highest precedence).

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [inventory_plugins]
use_extra_vars = no

  • Environment variable: ANSIBLE_INVENTORY_USE_EXTRA_VARS

Examples

# File must be named kubevirt.yaml or kubevirt.yml

# Authenticate with token, and return all virtual machines for all namespaces
plugin: community.kubevirt.kubevirt
connections:
 - host: https://kubevirt.io
   token: xxxxxxxxxxxxxxxx
   ssl_verify: false

# Use default config (~/.kube/config) file and active context, and return vms with interfaces
# connected to network myovsnetwork and from namespace vms
plugin: community.kubevirt.kubevirt
connections:
  - namespaces:
      - vms
    network_name: myovsnetwork

Authors

  • KubeVirt Team (@kubevirt)