In the top index page of the document, some sections had actual
contents and some had only links to the contents. However, this
makes it difficult for readers to get what is in the document and
what isn't at a glance.
This patch cleans it up to simplify the top index. This patch also
renames some of the directories to follow the doc layout rules[1].
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Note that the following ToDo is left for further cleanup:
* Publish the api guide and move the microversion history to
the `/api-guide` directory
Change-Id: Ideb1d5e7c74d1d564d07bac1a1e7c86c55ede873
When you create the placement document locally with `tox -e docs`,
some of the files are created under the `doc/source/_static` directory
and are tracked by git because the .gitignore file is not set
appropriately. This patch fixes it cleaning up old nova configurations
in the .gitignore file.
Change-Id: I1ecae90c9ba1cccdcd4befec3513ba2fdacb4cea
This adds a granular policy checking framework for
placement based on nova.policy but with a lot of
the legacy cruft removed, like the is_admin and
context_is_admin rules.
A new PlacementPolicyFixture is added along with
a new configuration option, [placement]/policy_file,
which is needed because the default policy file
that gets used in config is from [oslo_policy]/policy_file
which is being used as the nova policy file. As
far as I can tell, oslo.policy doesn't allow for
multiple policy files with different names unless
I'm misunderstanding how the policy_dirs option works.
With these changes, we can have something like:
/etc/nova/policy.json - for nova policy rules
/etc/nova/placement-policy.yaml - for placement rules
The docs are also updated to include the placement
policy sample along with a tox builder for the sample.
This starts by adding granular rules for CRUD operations
on the /resource_providers and /resource_providers/{uuid}
routes which use the same descriptions from the placement
API reference. Subsequent patches will add new granular
rules for the other routes.
Part of blueprint granular-placement-policy
Change-Id: I17573f5210314341c332fdcb1ce462a989c21940
The os-testr 1.0.0 release had a couple of required config changes due
to it's internal usage of stestr. This commit fixes those by adding a
.stestr.conf (to remove a warning) sets the fixture env variables in
the tox.ini instead of being hidden in .testr.conf and removing the
quotes around posargs to make passing args to ostestr actually work.
Also to keep the expected dev experience stestr is used directly for
places where ostestr was called directly.
Change-Id: Ib0fbcb2e7710a6b8219c56ef2a4462c61ea498a9
This consists of a duplicate of the [nova-]api-ref setup and
conf.py along with tooling to fail the tox -edocs target when
a route that is defined in
nova.api.openstack.placement.handler.ROUTE_DECLARATIONS is not
present in placement-api-ref/source/index.rst.
tools/placement_api_docs.py will report which routes are missing.
Though completely gameable (as demonstrated in the current lame
index.rst) it's better than nothing and provides some useful
structuring on what to do next. It's also the case that the 'docs'
target in tox is not part of gating.
The response for GET / is in place with the necessary
parameters.yaml for it to be correctly described. The 'get-root.json'
file provides the JSON of the expected response. The expectation is
that later commits will add information for other urls and their
JSON files will be named method-path-separated-by-dash.json with a
request/response qualifier as necessary.
Followup patches will add other routes.
A new parameters.yaml is used instead of reusing the one from
api-ref as there isn't a lot of expected overlap and having a
separate file will ease eventual extraction.
Running tox -eplacement-api-ref will generate the docs for review,
with output in placement-api-ref/build/html/index.html.
This will be hooked up with CI to deploy the generated docs,
eventually.
Change-Id: Ifb4d91d39db0e49b55952e37cdfc9f63dcd37aa3
This adds the entry point and config file necessary for using the
oslo.policy sample generation script. It also adds a tox target to
simplify the usage of it.
The command is also run in the docs tox target since the sample file
can be considered documentation.
Change-Id: I18a1fa567fc04b0e0a37c02f20024b2ce483f060
Partially-Implements: bp policy-in-code
This makes `git clean -df` actually remove the covhtml
directory and contents if you've run `tox -e coverage`.
Change-Id: I5db42524f9511c009289380e342b0b61f79899c2
Since reno is the new tool for Relnotes [1], we need to add it
to Nova and provide some Sphinx docs for Liberty and Mitaka.
Change-Id: Ibd74e62b6f36076dbec17dd146632fd42aad6eb2
Uses openstackdocstheme to match other content
Has a dependent change in project-config also so that
file will build to developer.openstack.org/compute
at https://review.openstack.org/#/c/231000/
Change-Id: Ic060a1e79e4b2f8695cb788ff4df018e0cfd3286
When using ctags, it will provide a 'tags' file in the directory.
It should be added to .gitignore.
Change-Id: If393c934a72397e755fc9e9672bb8d610d589a83
This commit adds sample config file generation to the nova devref
using the oslo.config sphinxconfiggen module which was recently added.
This will generate a new sample config each time build sphinx is run.
This is then used on a new docs page where you can either view the file
in its entirety, or download the file. The sphinx module was added in
the oslo.config 2.3.0 release.
Change-Id: I6d9150d81c8204bee8f775021a854928671bdd02
The pylint tests have been broken for several months and
the Jenkins job has also been disabled. There has been
no sign of attempts to address this, so just delete what
remains of the pylint support so developers don't mistakenly
think it is supposed to work with patches they are submitting.
Change-Id: Ifacc99e45acb0e9a72be6c31113e0cf073354f02
This commit removes the duplicate entry in the gitignore file for the
sample config file.
Closes-Bug: #1375432
Change-Id: Ied0fb5b38a616bbde871dfc690ccccfd46c94bde
Since we have already remove this sample file, and provided a way
to generate it, it should be no longer tracked.
Change-Id: I786812d039d96044ff5040d09f5472051966f74f
Closes-Bug: #1320150
Now that we aren't storing this in tree and are recommending people
generate it locally add nova.conf.sample to .gitignore.
Change-Id: I0727c7552fead5a201116f9c2c6510fec3b92cd6
This gets us up to date with common/setup.py and replaces custom nova
autodoc generation with the port of that code found in common.
Change-Id: I2a1c5d2c0fdcf40dbea50cc123b537adb068cdc2
sort .gitignore using sort -V to create something more readable
for future additions, instead of always appending to the end
of the file.
Change-Id: I7e5f0a792b5555a3c53f6da124572e0e3a7d7f9b
eclipse is far too commit happy to keep adding these files into the
tree making it a manual process to remove them before submit. This
should make life a little simpler for people using pydev.
Change-Id: Icd0ceea53daa76e6c36933ced174a235e070c394
The code to generate the authors file from the git changelog has been in the
tree and running for a few weeks now. Somehow the removal of the authors
test and and the MANIFEST.in file were wrong though. This should clean that
up.
Fixes bug 920757.
Change-Id: I66c388c1c81804f8dabc52b5ee25c7f394921e11
Shrink tox.ini to the new short version.
Fix the test cases to be able to be run in nosetets plus the
openstack.nose_plugin, which finally removes the need for
nova/testing/runner.py
Also, now we'll just output directly to stdout, which will
make nose collect the trace logging directly and either output
it at the end of the run, or inject it into the xunit output
appropriately.
Change-Id: I1456e18a11a840145492038108bdfe812c8230d1
Coverage report generation was not using --include filters.
This resulted in generating a report that included all external
dependencies. Some of these may include problematic characters for
utf8 decoding. In the odd case this was found, coverage would fail
with a UnicodeDecodeError.
Fixes bug #987077.
Change-Id: I276698e65ac1037972209a406058168433cd826b
If we structure things like this, we can get things
actually, you know, installed.
Locales ast and oc aren't supported by babel. We'll re-import them
from Launchpad once we get babel updated.
If you want translations installed, run:
python setup.py compile_catalog
Before you run either setup.py sdist or setup.py install
More work is needed to actually properly use the installed translations, but
we're closer.
Change-Id: I4a4bedd982c89063aa09688c9cbcf97054bcb34b
We moved to DistUtilsExtra because it promised a more automatic workflow
from setup.py. It doesn't actually deliver though, and it also vomits
warnings during setup.py usage, and also breaks pip integration.
So this is going back to babel. Mostly folks shouldn't need to know
anything about this. We'll need to update the translations import
jobs in Jenkins, and we might need to add a corresponding translations
upload job that runs post-merge.
Translations installation doesn't fully work - but it actually wasn't fully
working before. Getting this part of the project done now though is a
pre-requisite for using tox for multi-python testing (tox starts by
creating an sdist tarball and then installing it into the venv, which
is just 100% broken with DistUtilsExtra)
Change-Id: I126e1bcfab0656eab6ca10de67d3d2aaa8b844f3
This simplifies a number of Jenkins jobs which currently, other
than directory names, could be the same for all OpenStack
projects. By renaming the virtualenv directory, the redundant
Jenkins virtualenv build and copy jobs can be eliminated.
Change-Id: Ieaf1dac3207ecb34b911c7edcd2086809abdf49e
Tetsuro Nakamura