Cyborg

Overview
Cyborg (previously known as Nomad) is an OpenStack project that aims to provide a general purpose management framework for acceleration resources (i.e. various types of accelerators such as GPU, FPGA, ASIC, NP, SoCs, NVMe/NOF SSDs, ODP, DPDK/SPDK and so on).

Cyborg
We align with the official release schedule:https://releases.openstack.org/, with three milestones. We use storyboard to track all bugs and features. The cyborg basic board page[], with three worklists, track specific tasks in the three milestones.

People

 * PTL
 * Xinran Wang(xinranwang)
 * Cyborg Code Reviewers
 * cyborg-core-team
 * Blueprint Czar (responsible for maintenance of Cyborg's blueprint lists)
 * Same as PTL
 * [Release Management Liaisons]
 * Same as PTL
 * [Oslo Liaisons]
 * Shaohe Feng(shaohe_feng)
 * [QA Liaisons]
 * Chenke(chenker)
 * [Doc Liaisons]
 * Xinran Wang(xinranwang)
 * Nova Group Liaisons(works with nova team around Cyborg things)
 * Brin Zhang(brinzhang)
 * Xinran Wang(xinranwang)
 * Neutron Group Liaisons(works with neutron team around Cyborg things)
 * Xinran Wang(Xinran)

Meeting/Materials

 * Please refer to Meetings/CyborgTeamMeeting for Cyborg weekly meeting agenda and logistic info
 * Please refer to Cyborg/Materials for additional materials regarding Cyborg.
 * Please refer to Cyborg/MeetingLogs for meeting minutes archives.
 * Please refer to Cyborg/FirstContact for local on-boarding meeting agenda and logistic info

General Resources
NOTE: Please be aware that this page is incomplete, we will continually update this page! We will not remove this note until we think that all the imperative documentation is done here. If you need any help in using Cyborg, please just ping in the IRC channel #openstack-cyborg.

Supported Device Driver List and Test Report
Driver Test Report

Accelerator API reference

 * Accelerator API reference

End User Guide

 * End User Guide

Releasenotes

 * cyborg (and other projects under the compute program in governance) are released through the standard openstack release process: https://github.com/openstack/releases/blob/master/README.rst
 * All cyborg releasenotes
 * Latest cyborg releasenote

Contributor Documentation

 * General Developer's Guide
 * [ TODO(yumeng): add doc here once get merged Cyborg Architecture and long term plan Docs]
 * [ TODO(yumeng): add doc here once get merged Cyborg-driver process]

Bug Report and Feature Registration Guide
After Rocky, Cyborg has migrated from cyborg-launchpad to cyborg-storyboard to track bugs and features. But we were not using it very well. From Victoria, we will use it, use it well, and use it often. If time is very limited for you to walk through all the documentation, go directly to the Cyborg Specific Storyboard Usage Guide, and please pay close attention to the tags!


 * General Storyboard Usage
 * Cyborg Specific Storyboard Usage Guide

Development Release Schedule

 * Cyborg Yoga Release Schedule
 * Cyborg Xena Release Schedule
 * Cyborg Wallaby Release Schedule
 * Cyborg Victoria Release Schedule

History
Howard (Zhipeng) Huang started OpenStack acceleration mission discussion from Telco requirements and build the Great Founding Team of Cyborg. Under his leadership, we established the basic infrastructure for sustained growth, resulting in our official release in Rocky. Stein release, with Li Liu as the PTL, we have made substantial progress, particularly in defining a clean database schema and device model that will form the basis for future work. In both previous cycles, we had several illuminating discussions with Nova developers to define how Cyborg would interact with Nova. In the following Train and Ussuri releases, under Sundar Nadathur's leadership, Cyborg has reached an exciting and significant milestone, where Cyborg integration with Nova (compute service) has been completed. Users can now use Nova to launch server instances with accelerators provisioned with the Cyborg service.


 * Previous PTLs
 * Zhipeng Huang, Rocky Release
 * Li Liu, Stein Release
 * Sundar Nadathur, Train and Ussuri Releases
 * Yumeng Bao, Victoria and Wallaby Release


 * Previous or current core reviewers:
 * Wenping Song
 * Brin Zhang
 * Shogo Saito
 * Chen Ke
 * Sundar Nadathur
 * Xinran WANG
 * Jinghua Gao
 * Yumeng Bao
 * Zhenghao Wang
 * ShaoHe Feng
 * Li Liu
 * Li Zhu
 * Zhipeng Huang


 * Team Photo