https://github.com/meffie/molecule-virtup

Virt-up Molecule Plugin :: run molecule tests using libvirt and virt-builder
https://github.com/meffie/molecule-virtup

libvirt molecule-driver virt-builder

Last synced: 10 months ago
JSON representation

Virt-up Molecule Plugin :: run molecule tests using libvirt and virt-builder

• Host: GitHub
• URL: https://github.com/meffie/molecule-virtup
• Owner: meffie
• License: mit
• Created: 2021-03-20T23:58:59.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-11-11T20:57:48.000Z (over 4 years ago)
• Last Synced: 2025-08-12T04:46:35.632Z (10 months ago)
• Topics: libvirt, molecule-driver, virt-builder
• Language: Python
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
**********************

Molecule VirtUp Plugin

**********************

Molecule VirtUp is designed to allow use of `virt-up`_ for provisioning of

molecule test guests on a libvirt based hypervisor.  The libvirt hypervisor

may be local or remote.

See `virt-up`_ for installation instructions.

.. _`virt-up`: https://github.com/meffie/virt-up.git

Requires

========

On the hypervisor (local or remote)

* libvirt based hypervisor

* ssh server and connection credentials if remote

* python virt_up module and dependencies

Supported libvirt providers:

* qemu/KVM

* XEN

Example

=======

To use this plugin, you'll need to set the ``driver`` and ``platform``

variables in your ``molecule.yml``. Here is a example using the

``generic/centos8`` template:

.. code-block:: yaml

   driver:

     name: virtup

     options:

        connection: local

        host: localhost

        port: 22

        python_interpreter: "/usr/bin/python3"

        libvirt_default_uri: "qemu:///session"

        config_home: "~/.config/virt-up"

        data_home: "~/.local/share/virt-up"

   platforms:

     - name: instance

       template: generic/centos8

       memory: 512

       cpus: 1

Environment variables

=====================

VIRTUP_OPTIONS_FILE

  Specifies the path to the external yaml formatted options file.  An external

  driver options yaml file is supported in order to promote driver independent

  molecule scenarios. Options specified in the ``molecule.yml`` take precedent.

  Default: ``~/.config/molecule-virtup.yml``

Example:

.. code-block:: yaml

    ---

    connection: ssh

    host: kvm.example.com

    port: 22

    libvirt_default_uri: "qemu:///session"

Options

=======

connection

  The **ansible_connection** type used when connecting to the hypervisor; ``local`` or ``ssh``.

  Default: local

host

  The **ansible_host** used when connecting to the hypervisor.

  Default: localhost

port

  The **ansible_port** used when connecting to the hypervisor.

  Default: 22

user

  The **ansible_user** used when connecting to the hypervisor.

  Default: None

loglevel

  The logging level name. Log messages are written to the syslog on the hypervisor.

  Specify one of: critical, error, warning, warn, info, debug

  Default: info

config_home

  Specifies the ``virt_up`` configuration directory path.

data_home

  Specifies the ``virt_up`` data directory path.

python_interpreter

  Specifies the **ansible_python_interpreter** on the hypervisor.

  Default: Detected by ansible

libvirt_default_uri

  The libvirt local connection URI when the ``LIBVIRT_DEFAULT_URI`` environment

  variable is **not** present on the hypervisor for the ansible user. This URI should

  be a **local** connection URI, not ssh. The connection URI is used by the

  module running on the hypervisor to connect to the local libvirt daemon also

  running on the hypervisor.

  **virt_up** defaults to ``qemu:///session`` when the ``LIBVIRT_DEFAULT_URI``

  environment variable is not set on the hypervisor and the

  **libvirt_default_uri** option is not specified.

  Default: None

password

  The **ansible_password** used when connecting to the hypervisor.

  Default: None

ssh_private_key_file

  The **ansible_private_key_file** used when connecting to the hypervisor.

  Private key file used by ssh. Useful if using multiple keys and you don’t want to use SSH agent.

  Default: None

ssh_common_args

  The **ansible_ssh_common_args** used when connecting to the hypervisor.

  This setting is always appended to the default command line ssh..

  Default: None

ssh_extra_args

  The **ansible_ssh_extra_args** used when connecting to the hypervisor.

  This setting is always appended to the default ssh command line.

  Default: None

ssh_pipelining

  The **ansible_ssh_pipelining** used when connecting to the hypervisor.

  Determines whether or not to use SSH pipelining.

  Default: None

ssh_executable

  The **ansible_ssh_executable** used when connecting to the hypervisor.

  Overrides the ssh command to be used.

  Default: None

Platform parameters

===================

template

  Name of the ``virt-up`` template definition on the hypervisor. See ``virt-up show templates``.

  Aliases: box

  Default: default

size

  Image size expressed as , for example 10G.

  Default: set by template definition

memory

  Memory size of virtual machine in Mb. e.g. 2048

  Default: set by template definition

cpus

  Number of virtual cpus, e.g. 1

  Default: set by template definition

Authors

=======

Molecule Virt-Up Plugin was created by Michael Meffie based on code from

Molecule.

License

=======

The `MIT`_ License.

.. _`MIT`: https://github.com/meffie/molecule-virtup/blob/master/LICENSE