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
Update Sphinx version as well.
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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I612722e75975d6cfd5fc61037834b675117019e7
As the Ussuri goal we have an OpenStack project wide contributing
documentation template [1]. os-vif use its own bug or feature
tracking LP and core team is also not exactly same as nova so adding
its own contributor guide with keeping common links from nova
with os-vif specific information.
Also the top level CONTRIBUTING.rst template has been changed in the
cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according
to the new template.
[1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/$
[2] https://review.opendev.org/#/c/696001
Change-Id: I6017fdbb403d4cd90f4c3c2bd4a197dfbb67f6ec
Story: #2007236
Task: #38541
Few warnings are now failing as error:
- duplicate autoclass for VIFDirect
- case sensitive for glossary terms 'Linux Bridge'
Change-Id: I58d7fd85d98333bee387feff7b2c3d6f2f9102f4
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Iacccbabe71f3b68bdf28ecc349571887f191a3cd
1. Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.
2. Update some URLs to latest
3. Remove unncessary "=="
Closes-Bug: #1835804
Change-Id: I36fbb56a56832d535facd9bff25d352c8f0274a1
TC Offload capabilities have been present in Linux Kernel 4.13 for
hardware offloads. Currently OVS supports offloads (for OVS 2.8 and later)
with similar efforts planned for vrouter (OpenContrail and Tungsten
Fabric).
The existing method in os-vif is to pass the metadata required for
plugging via a VIFPortProfileOVSRepresentor port profile object. This is
used by the 'ovs' reference plugin and the external 'agilio_ovs' plugin.
With 'vrouter' being the third user of such metadata, it would be more
elegant to clean up this interface by using a composition pattern rather
than an inheritance based pattern.
Change-Id: I401ee6370dad68e62bc2d089e786a840d91d0267
Needed-By: I327894839a892a976cf314d4292b22ce247b0afa
Signed-off-by: Jan Gutter <jan.gutter@netronome.com>
blueprint: generic-os-vif-offloads
* This whitespace-only patch reflows the docs (mostly) to 79 columns,
except for unbreakable links.
* The glossary also had a missing newline at the end of the file.
Change-Id: I8a6c741555de5ed62990fbb2c034651f73327784
Signed-off-by: Jan Gutter <jan.gutter@netronome.com>
This change adds new nested DPDK VIF type and port profile for use with nested
DPDK driver in kuryr-kubernetes.
Co-Authored-By: Gary Loughnane <gary.loughnane@intel.com>
Co-Authored-By: Kural Ramakrishnan <kuralamudhan.ramakrishnan@intel.com>
Co-Authored-By: Marco Chiappero <marco.chiappero@intel.com>
Change-Id: Ib38c427b84606fd232c2ce35cab520790d6ad8ae
Signed-off-by: Przemyslaw Lal <przemyslawx.lal@intel.com>
- This change converts os-vif to use
sphinx-build and doc/requirements.txt to
be inline with new PTI requirements.
- This change tests docs requirements as part
of the lower-constraints env.
Change-Id: Ic136941a17f90d6a6a8432fec96f8612c4bca8a2
The usage doc stated that plug and unplug accept a single argument of
type `os_vif.objects.VIF`, which isn't a thing, and then went on to give
an example showing that they take two. The usage doc and the plug and
unplug docstrings also listed various objects at the wrong paths (e.g.
the `instance_info` param being of type `os_vif.objects.InstanceInfo`,
which also isn't a thing).
Fixed up the usage doc to list both arguments and correct the references
in the sample code; and fixed the plug/unplug docstrings
to list the proper paths to classes: os_vif.objects.vif.VIFBase and
os_vif.objects.instance_info.InstanceInfo.
Made everything in `single backticks` into a proper rst ``literal``.
Change-Id: I400838bbe9663917fe2c64f52975b77a370405b4
- Definition lists can't have newlines between the term and definition
- Asterisks should be preferred to single backticks for italicising
text, as the latter means "default role" which can be customized in
some environments.
- Some literals aren't formatted as such
Change-Id: I0554a4ba49fd4cc071bc7f129686a7697b9c0d35
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Looks like this was copied from Glance's config, and retains a lot of
unnecessary config for same. Remove it all.
Change-Id: I559c9615f0243290d1eb7c410afc0d7d3b705e28
* This patch adds support for a VF representor port profile,
specifically supporting OVS. If representor_name is set, the os-vif
plugin is requested to rename the representor to that.
* Some VIF types already have a VF associated with them. In that case,
the PCI dev_address should copied to the VIF port profile subclassed
object's representor_address for use by os-vif plug/unplug. The
hypervisor will still use the VIF's dev_address for instance spawning.
Change-Id: Id95a9f311e71b3cefb170704728641a4a1a91144
Signed-off-by: Jan Gutter <jan.gutter@netronome.com>
The spec [1] recommends the following sections:
- install
- contributor
- configuration
- cli
- admin
- user
- reference
Only two of these are useful here:
- user
- reference
Add these and populate them.
[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration
Change-Id: Ieab6ad5ef43a172743053a1cffc8d46deb235277
In Kernel 4.8 we introduced Traffic Control (TC see [1]) hardware offloads
framework for SR-IOV VFs which allows us to configure the NIC [2].
Subsequent OVS patches [3] allow us to use the TC framework
to offload OVS datapath rules.
This patch adds plug/unplug when using ovs vif 'OVS_ACCELERATION'. The
plug method will lookup the VF representor and connect it to 'br-int',
while the unplug method will remove the VF representor from 'br-int'.
[1] https://linux.die.net/man/8/tc
[2] http://netdevconf.org/1.2/papers/efraim-gerlitz-sriov-ovs-final.pdf
[3] https://mail.openvswitch.org/pipermail/ovs-dev/2017-April/330606.html
Co-Authored-By: Stephen Finucane <sfinucan@redhat.com>
Change-Id: Ia8214d4da5edfdfc188dc4cf791613cb475dc4c3
I had trouble finding the hosted docs for os-vif, which means others are
likely to too. Use the oslo-style README and refer people to other
resources.
Change-Id: I5d7791c86051c5fef20e3deb8bddc29991dd61e3
This reverts commit 157bf4c5cc. The
feature hasn't merged into upstream OVS yet. We should wait until it
does so in the event that there are changes (or it fails to merge at
all).
Change-Id: I564cae602bd88d71ce0796202db764502b2108f1
In Kernel 4.8 we introduced Traffic Control (TC see [1]) hardware offloads
framework for SR-IOV VFs which allows us to configure the NIC [2].
Subsequent OVS patches [3] allow us to use the TC framework
to offload OVS datapath rules.
This patch adds plug/unplug when using ovs vif 'OVS_ACCELERATION'. The
plug method will lookup the VF representor and connect it to 'br-int',
while the unplug method will remove the VF representor from 'br-int'.
[1] https://linux.die.net/man/8/tc
[2] http://netdevconf.org/1.2/papers/efraim-gerlitz-sriov-ovs-final.pdf
[3] https://mail.openvswitch.org/pipermail/ovs-dev/2017-April/330606.html
Change-Id: I90120119800cc2d3083b832700cc3d2ca655e638
At the moment, these are a collection of links to other resources but
they can be populated further in the future.
Change-Id: I7be9eaba1989bd085389516e29f797a72b5a8417
This makes reading the source a lot easier. A small number of `code`
symbols are formatted as such.
Change-Id: Id9f223f0b424094e9f99d610b5f7b7731259d145
The 6WIND fast path technology provides connectivity for
vhostuser ports in traditional networks (including ovs,
linuxbridge, calico).
This patch defines new port profiles to model fast path vhostuser
vifs in order to provide os-vif plugin with enough information
for plug/unplug ports.
Signed-off-by: Francesco Santoro <francesco.santoro@6wind.com>
Change-Id: Ibae8e2ae145b2b9ad2b4955825638dee9b56f0aa
Start to fill out some content in the docs. This describes
the different VIF objects at a high level, and also the
host information objects and how they pass info to the
network service
Change-Id: I3455a756a64a1616c130cc96a8a834d6837aaa38
Initial commit using code imported from
https://github.com/jaypipes/os_vif
This patch also includes the following fixes to make the import pass all
jenkins jobs:
- add doc/source/conf.py and index.rst
- sync with global requirements
Change-Id: Iac6a9d45ea799eaa71f895af115e966c28246a22
wangjiaqi07