Authors:

Greg Sheremeta

Moti Asayag

Feature pages are design documents that developers have created while collaborating on oVirt.

Most of them are outdated, but provide historical design context.

They are not user documentation and should not be treated as such.

Documentation is available here.

Katello Integration

Summary

Katello is a content and life-cycle host manager. oVirt can leverage Katello capabilities to report errata information for hosts, vms or for the ovirt-engine server. Integration with Foreman was introduced in 3.5. Integrating with Katello (which is based on Foreman) extends it to support also the content management of the physical or virtual hosts.

The ovirt-Katello/Satellite integration supports Katello >= 2.1 =or Satellite >= 6.1

Owner

Name: Moti Asayag (Moti Asayag)
Email: masayag@redhat.com

Detailed Description

The Katello integration supports presenting available errata to the user, for both hosts or for the ovirt-engine server. See the following figure for the topology:

Errata information is not stored on the engine server, rather being queried from the Katello server each time it is requested by the administrator. Erratum includes the following details:

Id
Title
Description
Type
Issued date
Severity
Solution
Summary
Packages

Workflow

Any host should be registered to Katello and properly configured:

katello-agent installed
Subscribed to the relevant content view/environment/repositories within the Katello server.

The hosts are being identified at the Katello engine by their host name. Hence hosts added by their IP address to the system wouldn’t be able to report errata - since there is no measure to identify them within the Katello system. The motivation for reporting errata for hosts with host name (FQDN) in the system is to dismiss the need to maintain the external content host id on the ovirt-engine side as well.

Katello errata for hosts

Associate a host with the ‘Foreman’ external provider
- By provisioning a host via ‘Foreman’ external provider
- By updating the host via ‘Edit’, see:

UI: Go to “Hosts” —> “General” sub-tab —> “Errata”:

UI: Go to “Hosts” —> “General” sub-tab —> “Errata” –> Specific severity:

* In case no errata is available, the following message will be shown: "0 pending errata"

* In case the host is not associated with Katello, the 'Errata' section won't be shown within the 'General' sub-tab at all.

* In case of a problem with the Katello server, error alerts will be shown on the tabs:

API:
- /api/hosts/{host:id}/katelloerrata
- /api/hosts/{host:id}/katelloerrata/{katelloerratum:id}/

Katello errata for vms

Associate a vm with the ‘Foreman’ external provider
- By updating the VM via ‘Edit’ action.
- By provisioning a VM via ‘Foreman’ external provider (not supported in 3.6).

UI: Go to “VMs” —> “General” sub-tab —> “Errata”:

Required Mockup

UI: Go to “VMs” —> “General” sub-tab —> “Errata” –> Specific severity:

Required Mockup

* In case no errata is available, the following message will be shown: "0 pending errata"

* In case the host is not associated with Katello, the 'Errata' section won't be shown within the 'General' sub-tab at all.

* In case of a problem with the Katello server, error alerts will be shown on the tabs: **Required Mockup**

API:
- /api/vms/{vm:id}/katelloerrata
- /api/vms/{vm:id}/katelloerrata/{katelloerratum:id}/

Katello errata for ovirt-engine server

Since the expectation is to have very few ‘Foreman’ providers (or a single one), instead of managing registration of the ovirt-engine server to a specific provider, the system will iterate over the providers and will try to match a content host within Katello by the ovirt-engine host name.

The errata for the ovirt-engine server will be added to the ‘System’ tree:

* In case no errata is available, the following message will be shown: "0 pending errata"

* In case the ovirt-engine server is not associated with Katello, the 'Errata' node won't be shown on the system left-pane tree.

API:
- /api/katelloerrata
- /api/katelloerrata/{katelloerratum:id}/

Implementation

ovirt-engine will use the Katello/Satellite api for accessing the content host by its host name. Once the host is found, the engine will send another request for its errata information. The GET request is sent to the following url: https://{katello_server_name}/katello/api/v2/systems/{host:id}/errata?search=type=bugfix%20or%20type=security&per_page=20&page=2

Here is an explanation for the queried URL:

Base url for selecting errata of a specific content host: /katello/api/v2/systems/57bea7e0-88e1-4e39-a21a-a7eb59128f3a/errata
Filter by type ‘bugfix’ or ‘security’: ?search=type=bugfix%20or%20type=security
Specifying page size: &per_page=20
Specifying page number: &page=2

The request above produces the following response:

   {
     "page": "2",
     "per_page": "20",
     "results": [
        ... the errata info ...
      ]
     "search": "type=bugfix or type=security",
     "sort": {
         "by": null,
         "order": null
     },
     "subtotal": 64,
     "total": 73
   }

The response provides the following information:

‘page’ - the retrieved page
‘per_page’ - page size
‘subtotal’ - the size of the filtered response (applying search query)
‘total’ - unfiltered response size

Benefit to oVirt

oVirt will allow the administrator for view from a single system the availability for errata, categorized by their severity, for the ovirt-engine itself or for its managed hosts. The Host administrator could be updated about available errata and their importance from the same dashboard which he uses to manage the host configuration.

Integration with Foreman has introduced the Foreman external provider which is also used to register Katello server to the system.

Documentation / External references

Testing

Release Notes