OpenStack Accelerator (Cyborg)

Cyborg is a general management framework for accelerators such as FPGAs, GPUs, NICs, SSDs, and AI chips in OpenStack clouds.

Architecture Overview

Cyborg design can be described by the following diagram:

cyborg-api

REST API service that handles device profile queries, ARQ creation, and accelerator discovery. Supports POST/PUT/DELETE/GET operations and interacts with cyborg-agent and the database via cyborg-conductor.

cyborg-conductor

Central orchestration service that coordinates placement updates, device bindings, and database access between cyborg-api and cyborg-agent.

cyborg-agent

Runs on compute nodes and discovers local accelerators via drivers, reports inventory to the conductor, and manages device programming and attachment. See Cyborg Support Matrix for supported drivers.

Accelerator Drivers

Cyborg supports drivers for various accelerator types (FPGA, GPU, NIC, SSD, AI chips). See Driver Development Guide for extending Cyborg with new device types.

Installation Guide

• Installation Guide
  • Overview
  • Prerequisites
  • Installation Methods
  • Post-Installation
  • Next Steps
  • Related Documentation

Installation instructions for operators deploying Cyborg from source or packages, including prerequisites, configuration, and post-installation steps.

User Guide

• Using Cyborg with Your Instance
  • Prerequisites
  • User Requests
  • Discovering Available Devices
  • Creating Device Profiles
  • Creating Flavors with Accelerators
  • Preparing Instance Prerequisites
  • Creating Instances with Accelerators
  • Verifying Accelerator Attachment
  • Deleting Instances

End-user documentation for creating device profiles and requesting accelerators in instances.

Administration

Administrator Guide

Operational guides for managing Cyborg deployments, including placement integration, ARQ lifecycle, upgrades, and security.

• Acceleration Service
  • Overview
  • Coexistence with PCI whitelists
  • Placement update
  • User Requests
  • Updating the Request Spec
  • Accelerator Requests
  • Cyborg and Nova interaction workflow

Configuration Reference

Configuration options for Cyborg services and per-driver setup.

• Configuration Guide
  • Configuration options for the Acceleration service
  • Cyborg Policies
  • Accelerator Driver Configuration
  • Cyborg Policy Configuration Guide
  • Understanding Cyborg Policies

API Documentation

REST API Reference

• Cyborg API Reference: Complete reference for the accelerator API, including all methods and request/response parameters.

• REST API Version History: History of API microversion changes.

Command Line Tools

• Command-Line Interface Reference
  • cyborg-dbsync
  • cyborg-status

CLI reference for cyborg-status and other command-line utilities.

Developer Documentation

• Contributor Documentation
  • Basic Information
  • Contributing
  • Reviewing

Contributor guides covering repository structure, driver development, testing, release notes, and agentic coding conventions.

Search and Indices

• Search Page