# ovirt/ovirt-engine-sdk architecture

> Architecture diagram of the GitHub repository ovirt/ovirt-engine-sdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ovirt/ovirt-engine-sdk
- Repository: https://github.com/ovirt/ovirt-engine-sdk

## Overview

The oVirt Python SDK lets callers make Engine API requests through a connection and generated service objects, then converts XML responses into SDK values. Its documented generation workflow uses the API model to produce service, type, and reader code; the runtime also includes XML parsing/rendering backed by libxml2. The excerpts show service request handling and generator responsibilities, but not all runtime wiring, so uncertain XML-extension connections are marked unverified.

Main entry points: [`generator/src/main/java/org/ovirt/sdk/python/Tool.java`](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/Tool.java) (Generator tool), [`sdk/lib/ovirtsdk4/service.py`](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/service.py) (API services), [`generator/src/main/java/org/ovirt/sdk/python/PythonNames.java`](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonNames.java) (Python naming), [`generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java`](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java) (Service generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["SDK runtime"]
  node_connection["Connection<br/>[__init__.py]"]
  node_services["API services<br/>[service.py]"]
  node_http_types["HTTP messages<br/>[http.py]"]
  node_types["API types<br/>[__init__.py]"]
end

subgraph group_serialization["XML serialization"]
  node_reader["Response reader<br/>[reader.py]"]
  node_writer["Request writer<br/>[writer.py]"]
  node_xml_extension["XML extension<br/>[xml.c]"]
  node_xml_reader["XML parser<br/>[ov_xml_reader.c]"]
  node_xml_writer["XML renderer<br/>[ov_xml_writer.c]"]
  node_xml_utils["XML utilities<br/>[ov_xml_utils.c]"]
end

subgraph group_generation["SDK generation"]
  node_generator_tool["Generator tool<br/>[Tool.java]"]
  node_generator_api["Generator interface"]
  node_generator_names["Python naming<br/>[PythonNames.java]"]
  node_generator_buffer["Code buffer<br/>[PythonBuffer.java]"]
  node_service_generator["Service generator"]
  node_reader_generator["Reader generator"]
  node_types_generator["Type generator"]
  node_writer_generator["Writer generator"]
end

subgraph group_external["External systems"]
  node_engine["oVirt Engine API"]
  node_api_model["API model"]
  node_libxml["libxml2"]
end

node_caller(("SDK caller"))

node_caller -->|"creates"| node_connection
node_caller -.->|"uses"| node_services
node_services -->|"sends requests"| node_connection
node_services -->|"builds requests"| node_http_types
node_services -->|"serializes bodies"| node_writer
node_services -->|"reads responses"| node_reader
node_connection -->|"sends HTTP"| node_engine
node_engine -.->|"returns responses"| node_connection
node_reader -.->|"constructs values"| node_types
node_reader -.->|"parses XML"| node_xml_extension
node_writer -.->|"renders XML"| node_xml_extension
node_xml_extension -->|"initializes"| node_xml_reader
node_xml_extension -->|"initializes"| node_xml_writer
node_xml_reader -->|"uses utilities"| node_xml_utils
node_xml_writer -->|"uses utilities"| node_xml_utils
node_xml_reader -->|"parses with"| node_libxml
node_xml_writer -->|"renders with"| node_libxml
node_generator_tool -->|"runs generators"| node_generator_api
node_generator_tool -->|"uses names"| node_generator_names
node_service_generator -->|"implements"| node_generator_api
node_reader_generator -->|"implements"| node_generator_api
node_service_generator -->|"uses names"| node_generator_names
node_reader_generator -->|"uses names"| node_generator_names
node_types_generator -->|"uses names"| node_generator_names
node_writer_generator -->|"uses names"| node_generator_names
node_service_generator -->|"writes through"| node_generator_buffer
node_reader_generator -->|"writes through"| node_generator_buffer
node_types_generator -->|"writes through"| node_generator_buffer
node_writer_generator -->|"writes through"| node_generator_buffer
node_generator_tool -->|"loads model"| node_api_model
node_generator_tool -.->|"generates services"| node_service_generator
node_generator_tool -.->|"generates readers"| node_reader_generator
node_generator_tool -.->|"generates types"| node_types_generator
node_generator_tool -.->|"generates writers"| node_writer_generator

click node_connection "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/__init__.py"
click node_services "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/service.py"
click node_http_types "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/http.py"
click node_types "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/__init__.py"
click node_reader "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/reader.py"
click node_writer "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/writer.py"
click node_xml_extension "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/xml.c"
click node_xml_reader "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/ov_xml_reader.c"
click node_xml_writer "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/ov_xml_writer.c"
click node_xml_utils "https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/ov_xml_utils.c"
click node_generator_tool "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/Tool.java"
click node_generator_api "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonGenerator.java"
click node_generator_names "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonNames.java"
click node_generator_buffer "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonBuffer.java"
click node_service_generator "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java"
click node_reader_generator "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java"
click node_types_generator "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/TypesGenerator.java"
click node_writer_generator "https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_connection,node_services,node_http_types,node_types toneBlue
class node_reader,node_writer,node_xml_extension,node_xml_reader,node_xml_writer,node_xml_utils toneAmber
class node_generator_tool,node_generator_api,node_generator_names,node_generator_buffer,node_service_generator,node_reader_generator,node_types_generator,node_writer_generator toneMint
class node_engine,node_api_model,node_libxml toneRose
class node_caller toneIndigo
```

## Components

### SDK runtime

- [Connection](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/__init__.py): `sdk/lib/ovirtsdk4/__init__.py`
- [API services](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/service.py): `sdk/lib/ovirtsdk4/service.py`
- [HTTP messages](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/http.py): `sdk/lib/ovirtsdk4/http.py`
- [API types](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/__init__.py): `sdk/lib/ovirtsdk4/__init__.py`

### XML serialization

- [Response reader](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/reader.py): `sdk/lib/ovirtsdk4/reader.py`
- [Request writer](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/lib/ovirtsdk4/writer.py): `sdk/lib/ovirtsdk4/writer.py`
- [XML extension](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/xml.c): `sdk/ext/xml.c`
- [XML parser](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/ov_xml_reader.c): `sdk/ext/ov_xml_reader.c`
- [XML renderer](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/ov_xml_writer.c): `sdk/ext/ov_xml_writer.c`
- [XML utilities](https://github.com/ovirt/ovirt-engine-sdk/blob/master/sdk/ext/ov_xml_utils.c): `sdk/ext/ov_xml_utils.c`

### SDK generation

- [Generator tool](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/Tool.java): `generator/src/main/java/org/ovirt/sdk/python/Tool.java`
- [Generator interface](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonGenerator.java): `generator/src/main/java/org/ovirt/sdk/python/PythonGenerator.java`
- [Python naming](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonNames.java): `generator/src/main/java/org/ovirt/sdk/python/PythonNames.java`
- [Code buffer](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/PythonBuffer.java): `generator/src/main/java/org/ovirt/sdk/python/PythonBuffer.java`
- [Service generator](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java): `generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java`
- [Reader generator](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java): `generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java`
- [Type generator](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/TypesGenerator.java): `generator/src/main/java/org/ovirt/sdk/python/TypesGenerator.java`
- [Writer generator](https://github.com/ovirt/ovirt-engine-sdk/blob/master/generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java): `generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java`

### External systems

- **oVirt Engine API**
- **API model**
- **libxml2**

### Other components

- **SDK caller**

## Connections

- SDK caller → Connection: creates (evidence: `sdk/lib/ovirtsdk4/__init__.py`)
- SDK caller → API services: uses
- API services → Connection: sends requests (evidence: `sdk/lib/ovirtsdk4/service.py`)
- API services → HTTP messages: builds requests (evidence: `sdk/lib/ovirtsdk4/service.py`)
- API services → Request writer: serializes bodies (evidence: `sdk/lib/ovirtsdk4/service.py`)
- API services → Response reader: reads responses (evidence: `sdk/lib/ovirtsdk4/service.py`)
- Connection → oVirt Engine API: sends HTTP (evidence: `README.adoc`)
- oVirt Engine API → Connection: returns responses
- Response reader → API types: constructs values (evidence: `sdk/lib/ovirtsdk4/reader.py`)
- Response reader → XML extension: parses XML
- Request writer → XML extension: renders XML
- XML extension → XML parser: initializes (evidence: `sdk/ext/xml.c`)
- XML extension → XML renderer: initializes (evidence: `sdk/ext/xml.c`)
- XML parser → XML utilities: uses utilities (evidence: `sdk/ext/ov_xml_reader.c`)
- XML renderer → XML utilities: uses utilities (evidence: `sdk/ext/ov_xml_writer.c`)
- XML parser → libxml2: parses with (evidence: `README.adoc`)
- XML renderer → libxml2: renders with (evidence: `README.adoc`)
- Generator tool → Generator interface: runs generators (evidence: `generator/src/main/java/org/ovirt/sdk/python/Tool.java`)
- Generator tool → Python naming: uses names (evidence: `generator/src/main/java/org/ovirt/sdk/python/Tool.java`)
- Service generator → Generator interface: implements (evidence: `generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java`)
- Reader generator → Generator interface: implements (evidence: `generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java`)
- Service generator → Python naming: uses names (evidence: `generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java`)
- Reader generator → Python naming: uses names (evidence: `generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java`)
- Type generator → Python naming: uses names (evidence: `generator/src/main/java/org/ovirt/sdk/python/TypesGenerator.java`)
- Writer generator → Python naming: uses names (evidence: `generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java`)
- Service generator → Code buffer: writes through (evidence: `generator/src/main/java/org/ovirt/sdk/python/ServicesGenerator.java`)
- Reader generator → Code buffer: writes through (evidence: `generator/src/main/java/org/ovirt/sdk/python/ReadersGenerator.java`)
- Type generator → Code buffer: writes through (evidence: `generator/src/main/java/org/ovirt/sdk/python/PythonBuffer.java`)
- Writer generator → Code buffer: writes through (evidence: `generator/src/main/java/org/ovirt/sdk/python/WritersGenerator.java`)
- Generator tool → API model: loads model (evidence: `README.adoc`)
- Generator tool → Service generator: generates services
- Generator tool → Reader generator: generates readers
- Generator tool → Type generator: generates types
- Generator tool → Writer generator: generates writers
