92 Commits

Author SHA1 Message Date
songwenping
9bbe9d2733 fix doc comment
Change-Id: Ia55824b7f7018e0221a67080d2cbc4a6a5d42a08
2022-09-06 11:05:21 +08:00
songwenping
f05e6e7e1d Add Xilinx FPGA driver in doc
Change-Id: Id3efacd6c8a151965a6375ba7b55d725849c0dd5
2022-09-06 09:47:38 +08:00
dengzhaosen
b83a97038e Update contributor page
This patch added the necessary notes about contributing in Cyborg.

Change-Id: Ie8b9b6d68b978302c2647a09746d9916965a194e
2021-12-16 09:01:04 +08:00
zhangbailin
2b24d6744b Add install index page
Change-Id: I4ba71572181238037fb6477f1b3fb3ac4ffed6ff
2021-12-15 00:44:47 +00:00
Zuul
2490e5b78f Merge "Doc Improvment:Add doc about cyborg-nova interaction" 2021-10-28 09:10:09 +00:00
Arthur Dayne
ade1972fc3 Doc Improvment:Add doc about cyborg-nova interaction
Change-Id: I850a7e29880a9744b18523281756bab2de1d5492
Closes-Bug: #1930404
2021-10-26 16:22:21 +08:00
zhangbailin
52563192d9 overriding configured project name with name extracted from the package (openstack-cyborg)
[openstackdocstheme] overriding configured project name (Python)
with name extracted from the package (openstack-cyborg); you can
disable this behavior with the 'openstackdocs_auto_name' option

Closes-Bug: #1946191

Change-Id: I5a4a8d7bfeb4b8f2c4c42ba685acd54a0b5d0689
2021-10-06 15:49:02 +08:00
zhangbailin
ce3d2cf312 Add the microversion history docs
We have added the microversion support, but lost the microversion
histroy docs, This patch provides the history of all those changes.
Consider it a "what's new" in the Cyborg API.

Change-Id: I885c456594184d949c929e1e87716e8a43f98818
2021-08-15 14:35:51 +08:00
songwenping
708fb15504 docs: Update Freenode to OFTC
http://lists.openstack.org/pipermail/openstack-discuss/2021-May/022780.html

Change-Id: I13e74ef3c66d71380e6fa0d0e773afcda359b0fc
2021-06-03 07:26:13 +00:00
Zuul
3476c144fd Merge "Give a more precise definition and fix a sphinx syntax error." 2021-05-25 10:26:29 +00:00
Arthur Dayne
a277abad84 Give a more detailed picture about the cyborg architecture.
Change-Id: I2b48e717ebb076eec4c57b629b8e4ac5b995cc9c
2021-05-14 16:53:39 +08:00
Arthur Dayne
fa09ba8076 Give a more precise definition and fix a sphinx syntax error.
Change-Id: I776b2e27259dc8de4c4a903e47f7141b67b1fcf5
2021-05-08 17:03:48 +08:00
Zuul
9fc6a30ea6 Merge "Switch using Launchpad instead of Storyboard" 2021-04-08 07:11:51 +00:00
zhangbailin
d9233bc429 Switch using Launchpad instead of Storyboard
In Xena release, we will using launchpad to trace Cyborg feature and
bugs, this patch changes the docs and releasenote config to launchpad.

Xena-PTG Etherpad: https://etherpad.opendev.org/p/cyborg-xena-ptg

Change-Id: I29c134420d341977a68ab11ba7dcb425caea44ff
2021-04-08 02:35:09 +00:00
songwenping
0e1bb834e7 Add backup and snapshot support matrix
Change-Id: I9eb0c097db8ded829d282256db4a8bdb971306f7
2021-04-07 03:01:00 +00:00
Zuul
d667954344 Merge "Add NVMe SSD driver" 2021-03-02 11:22:52 +00:00
zhangbailin
19b7d147ea Add NVMe SSD driver
This patch implemented NVMe SSD driver in Cyborg.
The Inspur NVMe SSD driver provides the discover and report proposal of
Inspur NVMe SSD disks, then we can use these disks binding and unbinding
with VM like PGPU to accelerator the io rate for the VM. The Inspur NVMe
SSD doesnot support virtualization, one disk can be only bind to one VM.

The spec is already commit. Please see:
https://specs.openstack.org/openstack/cyborg-specs/specs/wallaby/approved/nvme-ssd-driver-proposal.html

Please check the test report in the following link:
https://wiki.openstack.org/wiki/Cyborg/TestReport/InspurNVMeSSD

Co-Authored-By: Wenping Song <songwenping@inspur.com>

Change-Id: Ic474814b780e9beca6f19df50c9ce4c5553850a1
2021-03-02 08:36:40 +08:00
zhangbailin
7b1b9fb020 Update server operations support in matrix
We have already supported rebuild/evacuate[1] and shelve/unshelve[2]
a server with binding an accelerator. The evacuate and rebuild a server
has the same openstack command, so we just need to use ``openstack
server rebuild``.

[1]https://review.opendev.org/c/openstack/nova/+/715326
[2]https://review.opendev.org/c/openstack/nova/+/729563

Change-Id: Ida8f8d519792fe5e2748a67be5c502415dd4fe41
2021-03-01 16:34:25 +08:00
Zuul
1ff373e4f9 Merge "Add newline to enable lists" 2021-02-24 09:39:38 +00:00
Zuul
82d1ed968b Merge "Add intel NIC driver" 2021-02-07 08:45:36 +00:00
Xinran Wang
e3caf5cb0a Add intel NIC driver
This patch implements a new driver for Intel Nic Card. It
can discover the device and report it to Placement service with
CUSTOM_NIC resource class and specific traits.

Operator should specify the device and correspond profile in a
config file so that nic's driver can read the info from this
file.

Please check the test report in the following link:
https://wiki.openstack.org/wiki/Cyborg/TestReport/IntelNic

Change-Id: Ida0ba8f24b9e226da7f3d7a85fc372247e5281a5
Implements: blueprint sriov-smartnic-support
2021-02-04 08:40:23 +00:00
ericxiett
3d53b7a4dc Add newline to enable lists
This patch adds one newline for the lists of 'Accelerators'.

Change-Id: I2daf1c61f3c95dc5176bcc36be9f07949d55a933
2021-01-23 06:43:21 +00:00
Rocky
683c26e1f7 Installation document improvement
1) v2 api is used since v1 is deprecated and removed
2) host_ip configures the ip address on which cyborg-api listens, and
its default value(localhost) does not work in real cases
3) [nova] section config in cyborg.conf is also required

Change-Id: I4776147cdb6274fe269e1f1017ff9aad47bd63cc
2021-01-08 17:45:43 +11:00
yangyawei
39d51a0a86 remove unicode from code
Change-Id: I5407d29ba5dcc8647426091b0df51840c3272ba9
2021-01-03 15:50:56 +08:00
songwenping
583cc4583a Refresh cyborg-api link
Change-Id: I140480d8f67147f25217593d335db470aea9ca6b
2020-12-25 09:48:58 +08:00
zhangbailin
eabd6e1f79 Add microversion instructions
In Ussuri we introducing the microversion, and improved it in Victoria
release, now we should add the guide for using microversion.

Reference:
https://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html

Co-Authored-By: Wenping Song <songwenping@inspur.com>

Change-Id: Ia3d3175ca22b8c19c85f361989d759e47e5da759
2020-11-16 07:28:58 +00:00
zhangbailin
0da7417ccc Add index page for contributors guide
Add "releasenotes", "devstack_setup" and "driver-development-guide" to
the index page, and add a releasenote guide for users.

Change-Id: Ib9b36d015bac074fe65205c6ca14706e36e20195
2020-10-27 00:43:41 +00:00
Yumeng Bao
68c1f067bf add document for cyborg new policy
This patch added the document for new policy of cyborg inculding:
* cyborg policy concepts
* configuration guide
* all policies in code

Change-Id: I79472317c5c1b4aa2660e1c2d5cc61737299975a
Story: 2007024
Task: 40934
2020-09-27 14:16:37 +08:00
Yumeng Bao
99fd79e5a0 fix cyborg uwsgi doc error
Change-Id: I99c1912d31828f1b5538e316c66a0dc9b15ab369
2020-09-22 08:40:52 +00:00
Ghanshyam Mann
af49d0b30a Change default policy file from JSON to YAML
As Cyborg is switching to new policy, this is required
to avoid breaking the existing deployment using policy
file in json format and relying on default value of
'CONF.oslo_policy.policy_file'.

Default value of 'CONF.oslo_policy.policy_file' config option
has been changed from 'policy.json' to 'policy.yaml'. If new default
file 'policy.yaml' does not exist but old default 'policy.json' exist
then fallback to use old default file.

An upgrade checks is added to check the policy_file format and
fail upgrade checks if it is JSON formatted.

Added a warning in policy doc about JSON formatted file is deprecated,
also removed all the reference to policy.json file in doc as well as
in tests.

Related Blueprint: https://blueprints.launchpad.net/oslo.policy/+spec/policy-json-to-yaml

Change-Id: I865227e516dc7505c463ac279309169d95ea6a22
2020-09-18 14:16:31 +00:00
songwenping
970e6732a1 Add Inspur FPGA driver matrix
Change-Id: Id0ae5c93985d6ea381a1217214ec4048bd21550d
2020-09-03 20:39:50 +08:00
Xinran Wang
3ade5f8014 Add a new column in driver matrix
We need to add a new column to indicate the test report for
the driver who do not have 3rd party CI at present.

Change-Id: I64499715fae29f0f9189bf16178e9c0174abc835
2020-09-03 20:27:53 +08:00
Yumeng Bao
bf94ef8bdd update API documentation
The existed API documentation is not clear enough, which
caused misleading and confusion to end users and developers from other
community when talking about cyborg support in CNTT[1]. This patch updated the documentation to improve and avoid this kind of misleading.

[1] http://eavesdrop.openstack.org/meetings/openstack_cyborg/2020/openstack_cyborg.2020-07-09-03.01.log.html
Story: 2007809
Task: 40301

Change-Id: I3f882aa7c32b7439ab86e6658772f3d7630ab0c9
2020-07-15 12:42:47 +00:00
Zuul
8cf0310a75 Merge "Remove OPAE dependency in devstack" 2020-06-17 06:24:00 +00:00
Yumeng Bao
7ee7de1ec9 Remove OPAE dependency in devstack
This patch removes OPAE driver package from cyborg-agent dependencies due to
the following reasons:

1. In the kolla cyborg-agent image we install OPAE, but OPAE is not
available for CentOS 8 for the moment. This will make the cyborg-agent image
unbuildable in Ussuri[0].

2. In devstack, due to the fact that OPAE packages depend on libjson0, which
is not available after Ubuntu 16.04, so cyborg can't be installed on Ubuntu
higher than 16.04 now(unless disable dependency manually). Moreover,from
cyborg's perspective, it does not need to contain any hardware driver
dependency, we can assume the admin should know about it and install the
correct version.

3. We had an agreement at Victoria PTG that we should remove.[1]

[0]http://lists.openstack.org/pipermail/openstack-discuss/2020-June/015428.html
[1]https://etherpad.opendev.org/p/cyborg-victoria-goals L261

Change-Id: If0c92ea6ed98f195f5645ae0260855ed50f4f2a8
Story: 2007810
Task: 40078
2020-06-15 19:56:36 +08:00
zhangbailin
981d37cfc7 Enable openstackdocs config to storyboard
https://review.opendev.org/#/c/729944 renamed some config related to
launchpad, but Cyborg does not enable launchpad, using storyboard.
If the configuration is incorrect, they will add the bug icon to allow
reporting from a page.

Using openstackdocs_use_storyboard = True in the docs config file.

Talked in Ussuri PTG in Cyborg, whether launchpad is enabled for Cyborg,
we have not reached a consensus agreement.

See line 291: https://etherpad.opendev.org/p/cyborg-victoria-goals

Change-Id: Icfea14b07c3d87c28dcd05b2822f0c5fe0c12a60
2020-06-09 06:28:59 +00:00
Andreas Jaeger
eef6ddd62d Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I49a5a5876b0b995df0c3ce55fd517fa81bd79fd2
2020-05-21 14:35:22 +02:00
Zuul
3a600984f7 Merge "Update contributing.rst per Ussuri goal and guidelines." 2020-04-06 12:58:14 +00:00
Zuul
b20274eee6 Merge "Add Cyborg API Reference to Cyborg index page" 2020-04-02 04:53:56 +00:00
Sundar Nadathur
2b52672457 Update contributing.rst per Ussuri goal and guidelines.
Please see:
http://lists.openstack.org/pipermail/openstack-discuss/2020-March/013003.html

Change-Id: I8f4b8b25a0478d372f44e3691142a2d03a8bd01b
2020-04-01 06:54:09 +00:00
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
zhangbailin
31660c386a Add Cyborg API Reference to Cyborg index page
On the Cyborg latest page [1], the API link to the end user is missing.

This commits also removed bellow from the "Indices and tables":

* :ref:`genindex`
* :ref:`modindex`

[1] https://docs.openstack.org/cyborg/latest/

Change-Id: Ib7694effc38838829607c654fe4000eb51ca109f
2020-03-19 07:47:51 +00:00
Sean Mooney
67099829fa support standard devstack plugin cloning
This change removes the non standard mechanism
for specifying the cyborg repo and branch
via CYBORG_REPO and CYBORG_BRANCH.

in-tree devstack modules use the
<PROJECT NAME>_REPO and <PROJECT NAME>_BRANCH
convention for specifying revisions of project to clone
however devstack plugins should only use that convention
for cloning other git repos.

A devstack plugin should never clone the repo that contains
the plugin itself as doing so will replace the code while it
is executing. This can lead to the code that is running and the
code on disk being different if the plugin line and CYBORG_*
options do not match.

This change updates the devstack_setup docs with an example of
testing an unmerged change.

This change removes some commented out code and unneeded checks in
devstack/lib/*

Change-Id: I473ef276197ad6578f64a708f4b66562a2ff1d49
2020-03-16 13:49:52 +00:00
zhangbailin
aa2aa69e34 Remove the invalid specs from doc/source
The specs directory in Cyborg is not update, and we have the
Cyborg specifications in https://specs.openstack.org/openstack/cyborg-specs/,
so remove this directory in Cyborg, to reduce Cyborg maintenance costs.

Change-Id: Iebcbf2ebd6da3bc51e85c62f18c547909026c2f0
2020-02-12 15:31:04 +08:00
Zuul
0c72b024fd Merge "Bump the openstackdocstheme extension to 1.20" 2020-01-11 19:39:42 +00:00
Yumeng Bao
cb38eb9ff3 Remove api in doc
Since now cyborg has its own API documentation in the
OpenStack api-ref landing page, it's better to remove api doc from
the doc page, so that users won't get confused.

Change-Id: Ib20015f8233fb780eb5d77112bcb9b302a8e3f72
2019-11-25 01:23:28 -08:00
Zuul
1e08be3dc2 Merge "API documentation update." 2019-10-10 22:02:52 +00:00
Zuul
76cd113cab Merge "Update driver section." 2019-10-10 22:02:51 +00:00
pengyuesheng
e8b3051254 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.

Change-Id: I7407d8dd6261c18db9dd0f7ea8b5963738cfd7da
2019-10-09 09:42:52 +08:00
Sundar Nadathur
52494d89f7 API documentation update.
Change-Id: Ia4ca9e161d75bdc27ffc93d76bb82c636056b28e
2019-10-04 14:23:25 +00:00