The Ruby software development kit (SDK) is deprecated. Support for Ruby SDK will be removed in a later release.

The Ruby software development kit is a Ruby gem that allows you to interact with the {virt-product-fullname} {engine-name} in Ruby projects. By downloading these classes and adding them to your project, you can access a range of functionality for high-level automation of administrative tasks.

Prerequisites

To install the Ruby software development kit, you must have:

  • A system with {enterprise-linux} 8 installed. Both the Server and Workstation variants are supported.

  • A subscription to {virt-product-fullname} entitlements.

Installing the Ruby Software Development Kit

  1. Enable the required repositories:

    # subscription-manager repos \
    --enable=rhel-8-for-x86_64-baseos-rpms \
    --enable=rhel-8-for-x86_64-appstream-rpms \
    --enable=rhv-4.4-manager-for-rhel-8-x86_64-rpms

  2. Install the Ruby Software Development Kit:

    # dnf install rubygem-ovirt-engine-sdk4

    Alternatively, you can install with gem:

    # gem install ovirt-engine-sdk

Dependencies

The Ruby Software Development Kit has the following dependencies, which you must install manually if you are using gem:

  • libxml2 for parsing and rendering XML

  • libcurl for HTTP transfers

  • C compiler

  • Required header and library files

You do not need to install the dependency files if you installed the RPM.

Install the dependency files:

# dnf install gcc libcurl-devel libxml2-devel ruby-devel

If you are using Debian or Ubuntu, use apt-get:

# apt-get install gcc libxml2-dev libcurl-dev ruby-dev