ovirt/ovirt-engine-api-model

oVirt Engine API Model

oVirt Engine API Model

Welcome to the oVirt Engine API model source repository. This repository is hosted on GitHub:ovirt-engine-api-model

This project contains the specification of the oVirt Engine API, also known as the model.

The specification of the API is written using Java as the supporting language.

How to contribute

All contributions are welcome - patches, bug reports, and documentation issues.

Submitting patches

Please submit patches to GitHub:ovirt-engine-api-model If you are not familiar with the process, you can read about collaborating with pull requests on the GitHub website.

Found a bug or documentation issue?

To submit a bug or suggest an enhancement for oVirt Engine Extensions API please use oVirt Bugzilla for ovirt-engine product.

If you don't have a Bugzilla account, you can still report issues.

Still need help?

If you have any other questions or suggestions, you can join and contact us on the oVirt Users forum / mailing list.

ovirt-engine-api-model's Issues

Obsolete internal link format prevents migrating downstream API to Jupiter

The REST API is published downstream as part of RHV docs.

In 2022 (Q3, Q4?), all downstream Red Hat documentation is migrating to a new platform called "Jupiter". Jupiter does not support the cross-references (internal links) that the REST API model uses (example: "See, for example, the <<types/cluster, Cluster>> reference for a complete list of attributes." in Quick Start Examples.

These internal links must be updated to this format: "xref:link/path[Link text]." Note that "empty" xrefs ("xref:link[]") are not supported. The xref must contain a link text. For details, see Jupiter source files readiness checklist.

There are over 4000 occurrences of these cross-references in the REST API model, so updating them cannot be done manually by the RHV technical writers.

Missing host description in api response

When viewing host details through the oVirt web interface (located at Compute -> Hosts -> {Host} -> General -> Software), there's a field labeled OS Description that provides comprehensive information about the host's operating system. This can be visualized in the following image:

However, when retrieving the same host data via the oVirt API endpoint (/ovirt-engine/api/hosts/{{host_id}}/), the OS Description field seems to be absent. The JSON response includes various details about the OS, such as the type, version, and kernel command line, but not the full OS description. Here's a snippet of the API response for reference:

{
      "...": "...",
      "os": {
        "custom_kernel_cmdline": "",
        "reported_kernel_cmdline": "BOOT_IMAGE=(hd0,gpt2)/vmlinuz-5.4.17-2136.320.7.1.el8uek.x86_64 root=/dev/mapper/ol-root ro crashkernel=auto resume=/dev/mapper/ol-swap rd.lvm.lv=ol/root rd.lvm.lv=ol/swap rhgb quiet",
        "type": "RHEL",
        "version": {
            "full_version": "8.8 - 1.0.7.el8",
            "major": "8",
            "minor": "8"
        }
      },
      "...": "..."
}

Is this discrepancy in data presentation between the web UI and API by design? If so how can we obtain the complete OS description of a host (not just the type and version) through the API?

Build failure: `Fatal error compiling: error: release version 11 not supported`

Build fails with:

Downloaded from central: https://repo.maven.apache.org/maven2/org/codehaus/plexus/plexus-compiler-javac/2.8.4/plexus-compiler-javac-2.8.4.jar (21 kB at 86 kB/s)
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 621 source files to /mnt/workdir-81wny3nj/ovirt-engine-api-model/target/classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  6.428 s
[INFO] Finished at: 2023-09-19T06:15:56Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.0:compile (default-compile) on project model: Fatal error compiling: error: release version 11 not supported -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
make: *** [/mnt/workdir-81wny3nj/ovirt-engine-api-model/.copr/Makefile:12: srpm] Error 1
stderr: INFO: mock.py version 5.1.1 starting (python version = 3.11.3, NVR = mock-5.1.1-1.fc38)...

model.adoc issues

While serving model.adoc on oVirt webstie, jackyll reports:

asciidoctor: WARNING: model.adoc: line 57033: id assigned to section already in use: use-elements-instead-of-attributes-in-vcpu-pin
asciidoctor: ERROR: model.adoc: line 86: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 471: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 1192: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 56457: level 0 sections can only be used when doctype is book
asciidoctor: ERROR: model.adoc: line 56606: level 0 sections can only be used when doctype is book
asciidoctor: WARNING: model.adoc: line 57033: id assigned to section already in use: use-elements-instead-of-attributes-in-vcpu-pin

COPR build failing

Build in copr fails with:

Building for target x86_64
Executing(%prep): /bin/sh -e /var/tmp/rpm-tmp.4MeZyt
+ umask 022
+ cd /builddir/build/BUILD
+ cd /builddir/build/BUILD
+ rm -rf ovirt-engine-api-model-4.5.8
+ /usr/bin/mkdir -p ovirt-engine-api-model-4.5.8
+ cd ovirt-engine-api-model-4.5.8
+ /usr/bin/gzip -dc /builddir/build/SOURCES/ovirt-engine-api-model-4.5.8.tar.gz
+ /usr/bin/tar -xof -
/usr/bin/tar: This does not look like a tar archive
/usr/bin/tar: Exiting with failure status due to previous errors
error: Bad exit status from /var/tmp/rpm-tmp.4MeZyt (%prep)

above is from https://download.copr.fedorainfracloud.org/results/ovirt/ovirt-master-snapshot/centos-stream-8-x86_64/04441817-ovirt-engine-api-model/builder-live.log.gz

404 link to sdk example

• ./_site/documentation/doc-REST_API_Guide/model.html
  • External link https://github.com/oVirt/ovirt-engine-sdk/blob/master/sdk/examples/start_vm_with_cloud_init.py failed: 404 No error

Update CONTRIBUTING.md

CONTRIBUTING.md contains a lot of obsolete parts, it needs to be update to reflect current status