openstack/cyborg
Code Issues Proposed changes
Acceleration Management
563 Commits 13 Branches 57 Tags 15 MiB
Python 98.7%
Shell 1.2%
31d23b7315
Go to file
Arthur Dayne 31d23b7315 Generate PDF documentation 
- Add a new pdf-docs environment to enable PDF build.
- sphinxcontrib-svg2pdfconverter is used to handle SVG properly.
- maxlistdepth=10 in latex_elements is needed to handle
  deeper levels of nesting.
- Specify openany in extraclassoptions to skip blank pages
  (oneside is also specified to use the same page layout
   for even and odd pages)
- tocdepth is set to 2 for better PDF TOC
- printindex and makeindex are set to empty in latex_elements
  to avoid an empty "Index" section in PDF
- Sample config/policy files are skipped in the PDF document
  as inline sample files cause LaTeX error [1] and direct links
  in PDF doc is discouraged. Note that sample-config and sample-policy
  need to be excluded to avoid the LaTeX error [1] and
  :orphan: is specified in those files.

[1] https://github.com/sphinx-doc/sphinx/issues/3099

Change-Id: I70100a71114e1d75833e6c783086325baa0e3fd2
2020-03-21 15:02:55 +00:00
api-ref/source Merge "Bump the openstackdocstheme extension to 1.20" 2020-01-11 19:39:42 +00:00
cyborg Merge "Remove useless interfaces in agent" 2020-03-21 00:53:55 +00:00
devstack Fix setting cyborg agent hostname 2020-03-16 13:50:00 +00:00
doc Generate PDF documentation 2020-03-21 15:02:55 +00:00
etc/cyborg Modify api-paste.ini v1 to v2 2019-12-20 09:41:29 +00:00
releasenotes Merge "Introduce bandit security linter" 2020-01-14 03:58:49 +00:00
setup Cyborg deployment script 2017-08-30 09:27:56 -04:00
tools/config Fix tox -egenconfig 2018-06-10 16:37:40 +08:00
.coveragerc Exclude cyborg tests dir in UT cover report 2019-10-30 09:40:37 +08:00
.gitignore Exclude cyborg tests dir in UT cover report 2019-10-30 09:40:37 +08:00
.gitreview OpenDev Migration Patch 2019-04-19 19:39:22 +00:00
.stestr.conf Exclude cyborg tests dir in UT cover report 2019-10-30 09:40:37 +08:00
.zuul.yaml Introduce bandit security linter 2020-01-05 19:49:22 -08:00
babel.cfg initial setup "correct tox.ini testr and test-requirement.txt requirement 2016-01-18 14:29:39 +08:00
bindep.txt Add bindep support 2019-08-05 14:31:35 +08:00
CONTRIBUTING.rst Add gpu driver 2019-03-21 18:01:29 +08:00
HACKING.rst Add doc8 to pep8 check for cyborg project 2018-05-10 09:32:01 +07:00
LICENSE initial setup "correct tox.ini testr and test-requirement.txt requirement 2016-01-18 14:29:39 +08:00
README.rst Update README.rst for cyborg 2019-09-03 14:07:28 +08:00
requirements.txt Bump oslo.messaging version >= 10.3.0 2020-03-10 10:04:09 +08:00
setup.cfg Stop testing python2.7 2019-11-19 02:09:08 -05:00
setup.py uncap eventlet 2018-05-07 17:42:19 +03:00
test-requirements.txt Use ResourceNotFound replace RP and Image NotFound 2020-01-17 09:08:22 +00:00
tox.ini Generate PDF documentation 2020-03-21 15:02:55 +00:00

README.rst

Cyborg

OpenStack Acceleration as a Service

Cyborg provides a general management framework for accelerators such as FPGA, GPU, SoCs, NVMe SSDs, CCIX caches, DPDK/SPDK, pmem and so forth.

Features

  • REST API for basic accelerator life cycle management
  • Generic driver for common accelerator support