oVirt Engine Setup

This role is now part of oVirt Ansible Collection. Please make sure to use the latest version from that source. This repository is now read-only and is not being developed further.

This role installs the necessary packages to set up the oVirt Engine, creates an answer file, and runs the engine-setup process. Optionally, it can also update existing oVirt engine packages.

Important Note

When installing this role from Ansible Galaxy, make sure to run the following command:

$ ansible-galaxy install ovirt.engine-setup

This command will download the role into a directory named ovirt.engine-setup. Be mindful that the names are case sensitive. For example, if you enter OVIRT.engine-setup, it will create a directory called OVIRT.engine-setup, and you’ll always need to refer to it with that capitalization.

For RPM installations, the role can be referenced by three names: oVirt.engine-setup, ovirt.engine-setup, and ovirt-engine-setup. You can use any of these names, but this document will refer to it as ovirt.engine-setup, as the other two are deprecated.

Target Systems

• engine

Requirements

• A configured environment with the necessary repositories.
• Ansible version 2.9.0 or later.

Role Variables

By default, the engine-setup uses an answer file based on the version of oVirt specified with ovirt_engine_setup_version. You can provide your own answer file using the variable ovirt_engine_setup_answer_file_path.

Common Options for the Role:

Common Options for Engine:

Engine Database Configuration:

Data Warehouse Database Configuration:

OVN Configuration:

Apache Configuration:

Dependencies

None.

Example Playbooks

Here are some example playbooks for setting up oVirt or RHV:

---
# Example of setting up oVirt
- name: Setup oVirt
  hosts: engine
  vars_files:
    - passwords.yml  # Contains encrypted admin password
  vars:
    ovirt_engine_setup_version: '4.2'
    ovirt_engine_setup_organization: 'of.ovirt.engine.com'
  roles:
    - ovirt.engine-setup

# Example of setting up RHV
- name: Setup RHV
  hosts: engine
  vars_files:
    - passwords.yml  # Contains encrypted admin password
  vars:
    ovirt_engine_setup_version: '4.2'
    ovirt_engine_setup_organization: 'rhv.redhat.com'
    ovirt_engine_setup_product_type: 'rhv'
  roles:
    - ovirt.engine-setup

# Setting up oVirt with engine configurations
- name: Setup oVirt
  hosts: engine
  vars_files:
    - passwords.yml  # Contains encrypted admin password
  vars:
    ovirt_engine_setup_version: '4.4'
    ovirt_engine_setup_organization: 'of.ovirt.engine.com'
    ovirt_engine_setup_engine_configs:
      - key: SpiceProxyDefault
        value: prot://proxy
        version: general
  roles:
    - ovirt.engine-setup

# Restoring oVirt engine from a backup
- name: Restore oVirt engine
  hosts: engine
  vars_files:
    - passwords.yml  # Contains encrypted admin password
  vars:
    ovirt_engine_setup_version: '4.4'
    ovirt_engine_setup_organization: 'of.ovirt.engine.com'
    ovirt_engine_setup_restore_engine_cleanup: true
    ovirt_engine_setup_restore_file: '/path/to/backup.file'
    ovirt_engine_setup_restore_scopes:
      - 'files'
      - 'db'
    ovirt_engine_setup_restore_options:
      log: '/path/to/file.log'
      restore-permissions: ''
      provision-all-databases: ''
  roles:
    - ovirt.engine-setup