Commit Graph

17 Commits

Author SHA1 Message Date
U-HOME\songwenping 87b1165aa3 Remove unnecessary unicode prefixes
All strings are unicode by default in Python 3. No need to mark them as
such.

Change-Id: Id937b87f7c7e2767ce5eb456db39d8ce81a1a69a
2022-04-19 14:32:05 +08:00
Stephen Finucane c6a0ff2ac0 List traits in documentation
We're going to have to switch to something other than a list of strings
or use Sphinx-style inline documentation if we want to provide anything
more useful.

Change-Id: I45c29fe2bdd3fdcb3c69e07f5e9e5be36de9b797
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-09-23 12:05:41 +01:00
Andreas Jaeger e32a13f13c 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.

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: Id6a7a465630647382de63be64fc16f6e4f52912d
2020-06-01 15:28:05 +02:00
Andreas Jaeger 77bf79e2aa Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Switch to hacking 3.0

Change-Id: Id3a7e6b6a6160358efb897cbf73630d96672d4fb
2020-04-12 18:52:38 +02:00
Eric Fried 173298bf86 Stop testing with py2 and switch to ussuri jobs
Remove py2 from tox.ini, setup.cfg, and zuul.

Switch from train to ussuri zuul job template.

Change-Id: I70eeabe2237c3f13b7e7a27fb32c9d2cd1609333
2019-10-25 09:45:29 -05:00
Chris Dent d2d56c291b Build pdf docs
This follows the instructions [1] in an attempt to build pdf docs.

The goal is described as docs that get made, not necessarily
perfect docs. This gets that.

[1] https://etherpad.openstack.org/p/train-pdf-support-goal

Change-Id: Icf7c22bf9d1de6fb2a74a756c370930d4c00b0b9
Story: 2006110
Task: 35396
2019-09-11 13:24:44 +00:00
Zuul 9aaf82dded Merge "Update SEV trait docs to avoid misleading people" 2019-05-10 18:22:10 +00:00
Adam Spiers 3b9116739d Update SEV trait docs to avoid misleading people
Since the AMD SEV spec was approved for Stein, it was subsequently
realised that a trait would not be sufficient for tracking SEV-capable
compute hosts.  A resource class is also needed to track the inventory
of "slots" available on these hosts, since the number of slots limits
how many guests with encrypted memory can run concurrently.

Therefore the design pivoted somewhat, and now
trait:HW_CPU_AMD_SEV=required will not be the correct way to request
SEV functionality:

  https://specs.openstack.org/openstack/nova-specs/specs/train/approved/amd-sev-libvirt-support.html

For reference, the previous spec is here:

  https://specs.openstack.org/openstack/nova-specs/specs/stein/approved/amd-sev-libvirt-support.html

Another lesson learnt from the Stein cycle was that it is not safe to
assume that the work targeted for one cycle will actually land in that
cycle, therefore it's safer for documentation of an in-progress
feature to be transparent that it's in progress and not yet usable.

Change-Id: I6b652c20ba4f5ec775829a45939d708066dc3011
blueprint: amd-sev-libvirt-support
2019-04-25 18:19:02 +01:00
Adam Spiers f17a1ce37c Document policy of never removing traits
It has been asked at least twice in recent weeks (the first time by
me) why unused traits can't be removed from os-traits:

http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2019-04-18.log.html#t2019-04-18T17:59:58
http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2019-04-25.log.html#t2019-04-25T10:48:18

so let's explicitly document this policy to prevent future generations
getting confused, or worse, attempting to remove traits.

Change-Id: I4028c25ff5fc0adeca6ee62b0db11d8bbf909f28
2019-04-25 13:28:23 +00:00
Adam Spiers 7f43b7e9a9 Add HW_CPU_AMD_SEV trait
Add a trait reflecting a compute host's capability to offer AMD's
on-chip Secure Encrypted Virtualization functionality:

https://en.wikipedia.org/wiki/Zen_(microarchitecture)#Enhanced_security_and_virtualization_support
https://developer.amd.com/sev/

This will facilitate booting of security-sensitive VMs only on hosts
which offer additional security via SEV.  More details available here:

https://specs.openstack.org/openstack/nova-specs/specs/stein/approved/amd-sev-libvirt-support.html

Change-Id: I8ebfeac3cabbb64a7913f0b8193010a1b712382b
blueprint: amd-sev-libvirt-support
2019-02-08 00:47:57 +00:00
Jay Pipes 189fa9f027 clean up CUDA traits
There was a misunderstanding of what the CUDA traits really stood for.
This wasn't helped by the fact that the NVIDIA CUDA documentation and
versioning system is so awkward.

Basically, there's the CUDA Compute Capability version, which represents
the hardware GPU instruction set extensions supported by various NVIDIA
GPUs. And there is the CUDA SDK version which represents a window of
CUDA Compute Capability versions that the library is able to work with.

This patch adds a new os_traits.hw.gpu.cuda module with these new
traits. It removes the old os_traits.hw.gpu.api.CUDA* traits since those
were misleading and inaccurate.

It also adds a new utility function that maps CUDA SDK version to
supported CUDA Compute Capability versions that the SDK supports. This
support matrix information was taken from the CUDA wikipedia article
which lists the supported version information.

Change-Id: Id4adb6874615ad5f9f8aff780a83119e10a38c35
2018-09-19 10:03:54 -04:00
Victor Morales d7d055d8ad Update Usage information
This change includes the import of pprint module as well as updates
the information retrieved.

Change-Id: Ie2b0e734912bbd2a41ac4f324d61e8312203d723
2018-01-31 17:41:33 -08:00
Stephen Finucane 21b879b755 doc: Remove cruft from conf.py
Clean up both the releasenotes 'conf.py' and some remaining pieces of
the main 'conf.py'. In the case of the former, it looks like this was
copied from Glance's config, and retains a lot of unnecessary config for
same. Remove it all.

Change-Id: Ibce322af4441fef7ba0b1abe1b51070d49ad1df5
2017-08-23 09:46:37 +01:00
Stephen Finucane 5c46158f38 doc: Switch from oslosphinx to openstackdocstheme
Change-Id: I471868446a4ac89a63cc75b0d83caae21bd90fb8
2017-08-23 09:46:35 +01:00
Stephen Finucane 9ca11e9be0 doc: Create directory structure for docs migration
The spec [1] recommends the following sections:

- install
- contributor
- configuration
- cli
- admin
- user
- reference

Only a few of these are useful here:

- install
- contributor
- user
- reference

Add these and populate them.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I70c77761a0a26a46d092bb09a29374b72c0d49ca
2017-07-04 16:16:56 +01:00
Yingxin d56ac9facb Rename the rest capabilities to traits 2016-09-20 05:40:55 +00:00
Jay Pipes 7d2a583f32 Initial commit of os-capabilities library
Adds the basics of the new os-capabilities library, including a README
and a couple helper functions that allow the user to list both symbol
names as well as the capability strings themselves.

Added x86 CPU instruction set extensions as an initial set of namespaced
standardized capability strings.
2016-08-03 19:25:39 -04:00