Jump to: navigation, search

Difference between revisions of "Cyborg"

(Resources for Contributors)
(Contributor Documentation)
(34 intermediate revisions by 3 users not shown)
Line 13: Line 13:
 
| https://github.com/openstack/cyborg
 
| https://github.com/openstack/cyborg
 
|-
 
|-
| Bug tracker
+
| Bug and Feature tracker
|
+
| https://storyboard.openstack.org/#!/project/openstack/cyborg
|-
 
| Feature tracker
 
|  
 
 
|-
 
|-
 
| Developer doc
 
| Developer doc
Line 32: Line 29:
 
| https://github.com/openstack/python-cyborgclient
 
| https://github.com/openstack/python-cyborgclient
 
|-
 
|-
| Bug tracker
+
| Bug and Feature tracker
|  
+
| https://storyboard.openstack.org/#!/project/openstack/python-cyborgclient
|-
 
| Feature tracker
 
 
|  
 
|  
 
|}
 
|}
Line 44: Line 39:
 
| https://github.com/openstack/cyborg-tempest-plugin
 
| https://github.com/openstack/cyborg-tempest-plugin
 
|-
 
|-
| Bug tracker
+
| Bug and Feature tracker
|  
+
| https://storyboard.openstack.org/#!/project/openstack/cyborg-tempest-plugin
|-
 
| Feature tracker
 
 
|  
 
|  
 
|}
 
|}
Line 68: Line 61:
 
**Yumeng Bao(Yumeng)
 
**Yumeng Bao(Yumeng)
 
* Nova Group Liaisons(works with nova team around Cyborg things)
 
* Nova Group Liaisons(works with nova team around Cyborg things)
**Bailing Zhang(brinzhang)
+
**Brin Zhang(brinzhang)
 
**Yumeng Bao(Yumeng)
 
**Yumeng Bao(Yumeng)
 
* Neutron Group Liaisons(works with neutron team around Cyborg things)
 
* Neutron Group Liaisons(works with neutron team around Cyborg things)
Line 82: Line 75:
  
 
== General Resources ==
 
== 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.
  
=== Documentation ===
+
=== Supported Device Driver List and Test Report===
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.
+
[https://wiki.openstack.org/wiki/Cyborg/TestReport Driver Test Report]
  
 +
=== Accelerator API reference ===
 
* [https://docs.openstack.org/api-ref/accelerator/ Accelerator API reference]
 
* [https://docs.openstack.org/api-ref/accelerator/ Accelerator API reference]
 +
 +
=== End User Guide ===
 
* [https://docs.openstack.org/cyborg/latest/#for-end-users End User Guide]
 
* [https://docs.openstack.org/cyborg/latest/#for-end-users End User Guide]
  
=== Release Process ===
+
=== Releasenotes ===
 
* cyborg (and other projects under the [https://governance.openstack.org/tc/reference/projects/nova.html compute program in governance]) are released through the standard openstack release process: https://github.com/openstack/releases/blob/master/README.rst
 
* cyborg (and other projects under the [https://governance.openstack.org/tc/reference/projects/nova.html compute program in governance]) are released through the standard openstack release process: https://github.com/openstack/releases/blob/master/README.rst
 
* [https://releases.openstack.org/teams/cyborg.html All cyborg releasenotes]
 
* [https://releases.openstack.org/teams/cyborg.html All cyborg releasenotes]
Line 99: Line 96:
  
 
* [http://docs.openstack.org/infra/manual/developers.html General Developer's Guide]
 
* [http://docs.openstack.org/infra/manual/developers.html General Developer's Guide]
* [http://docs.openstack.org/developer/nova/devref/index.html Cyborg Architecture and long term plan Docs]
+
* [ TODO(yumeng): add doc here once get merged Cyborg Architecture and long term plan Docs]
* [http://docs.openstack.org/developer/nova/blueprints.html When you need a spec vs a blueprint]
+
* [ TODO(yumeng): add doc here once get merged Cyborg-driver process]
* [http://specs.openstack.org/openstack/nova-specs/readme.html cyborg-spec process]
 
* [https://wiki.openstack.org/wiki/Nova/BugTriage Bug Triage Process and Bug tag owners]
 
  
=== Bugs and Features Track ===
+
=== Bug Report and Feature Registration Guide===
 
After Rocky, Cyborg has migrated from [https://launchpad.net/openstack-cyborg cyborg-launchpad] to [https://storyboard.openstack.org/#!/project_group/77 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.  
 
After Rocky, Cyborg has migrated from [https://launchpad.net/openstack-cyborg cyborg-launchpad] to [https://storyboard.openstack.org/#!/project_group/77 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!
  
 
*[https://docs.openstack.org/infra/storyboard/#using-storyboard General Storyboard Usage]
 
*[https://docs.openstack.org/infra/storyboard/#using-storyboard General Storyboard Usage]
*[Cyborg Specific Storyboard Usage Guide]
+
*[https://wiki.openstack.org/wiki/Cyborg/CyborgStoryboard Cyborg Specific Storyboard Usage Guide]
  
Please be very careful to use a tag
+
=== Development Release Schedule===
valid tags are: cyborg-victoria
+
* [https://wiki.openstack.org/wiki/Cyborg/Wallaby_Release_Schedule Cyborg Wallaby Release Schedule]
https://storyboard.openstack.org/#!/board/216
+
* [https://wiki.openstack.org/wiki/Cyborg/Victoria_Release_Schedule Cyborg Victoria Release Schedule]
  
 
== History ==
 
== History ==

Revision as of 08:25, 23 November 2020

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).

Projects

Cyborg

Official name OpenStack Accelerator
Source code https://github.com/openstack/cyborg
Bug and Feature tracker https://storyboard.openstack.org/#!/project/openstack/cyborg
Developer doc


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.

Python Cyborg Client

Source code https://github.com/openstack/python-cyborgclient
Bug and Feature tracker https://storyboard.openstack.org/#!/project/openstack/python-cyborgclient

Cyborg Tempest Plugin

Source code https://github.com/openstack/cyborg-tempest-plugin
Bug and Feature tracker https://storyboard.openstack.org/#!/project/openstack/cyborg-tempest-plugin

People

  • PTL
    • Yumeng Bao(Yumeng)
  • Cyborg Code Reviewers
  • 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]
    • Yumeng Bao(Yumeng)
  • Nova Group Liaisons(works with nova team around Cyborg things)
    • Brin Zhang(brinzhang)
    • Yumeng Bao(Yumeng)
  • Neutron Group Liaisons(works with neutron team around Cyborg things)
    • Shaohe Feng(shaohe_feng)
    • Xinran Wang(Xinran)

Meeting/Materials

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

End User Guide

Releasenotes

Resources for Contributors

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!

Development 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
  • Previous or current core reviewers:
    • 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


Cyborg team photo denver.jpeg
Cyborg team photo dublin.jpg
Cyborg team photo denver 2018.jpg