[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
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
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
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
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
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
Add "releasenotes", "devstack_setup" and "driver-development-guide" to
the index page, and add a releasenote guide for users.
Change-Id: Ib9b36d015bac074fe65205c6ca14706e36e20195
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
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
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
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
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
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
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
- 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
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
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
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
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
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
